Skip to main content

Customer types

Not all holders are the same: a VIP, a trade customer, an employee, a regular customer. Customer types sort your holders into segments you define.

What they are for​

  • Show a status on the card: "Gold", "Pro", "Season ticket". The iOS header can show the type (iosHeader set to TYPE, see PATCH/store-cards).
  • Target a segment: send coupons and notifications to its customers (recipient list, target: SPECIFIC for notifications).
  • Move customers up: Silver → Gold, you change their type, their card updates.

Endpoints​

NeedEndpoint
List typesGET/client-types
Create a type (and make it the default with isDefault)POST/client-types
Read, edit, delete a typeGET/client-types/{id}, PATCH/client-types/{id}, DELETE/client-types/{id}
Assign a type to a customerclientType on POST/clients or PATCH/clients/{id}
POST/client-typesTry it
curl -L 'https://api-v2.test.eldowallet.fr/client-types' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-lang: en' \
-H 'Authorization: Bearer <token>' \
-d '{
"name": "Gold",
"isDefault": false
}'

The default type​

A wallet that uses types always has a default type. A customer created without a type gets it. You cannot remove the only default type: the API returns DEFAULT_CLIENT_TYPE_REQUIRED. Make another type the default first.

Assignment error

An unknown or malformed type when creating a customer returns ERROR_CUSTOMER_TYPE_ASSIGNMENT. Get the ids with GET/client-types.

Go further​

API news, once a month

New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

Report a technical problem

An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

For a fast answer, include:

  • The method and endpoint (e.g. POST /clients)
  • The error code returned (errorCode) and the body sent
  • The date and time of the call
  • The identifiers involved (customer, template, pass)

Never include an API token or a password.

AI assistant

Beta

Loading…

AI-generated answers (Claude): double-check important details.

Sign in to use the assistant