Skip to main content
POST
/
consumers
Create new consumer
curl --request POST \
  --url https://api.chift.eu/consumers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "<string>",
  "internal_reference": "<string>",
  "redirect_url": "<string>"
}'
{
  "consumerid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "email": "<string>",
  "internal_reference": "<string>",
  "redirect_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Body

application/json
​
name
string
required

Name of the consumer as it will appear in your Chift platform. This name may be used for automated communications, such as automatic mailings if you enable this feature.

Required string length: 1 - 255
​
email
string | null

Optional - Email address of the consumer. It can be used for sending automated reminders (if feature enabled) and deployment by mail of local agent (when on-premise connector).

Maximum length: 80
​
internal_reference
string | null

Your internal reference for the client (e.g., customer ID or unique identifier in your system).

Maximum length: 255
​
redirect_url
string | null

URL to redirect the user after completing the activation via our link. Useful for directing customers to a dynamic or personalized url. You can also set up a default static URL in Chift's back office for all consumers.

Maximum length: 255

Response

Successful Response

​
consumerid
string<uuid>
required

Unique id of the consumer in Chift

​
name
string
required

Name of the consumer as it will appear in your Chift platform. This name may be used for automated communications, such as automatic mailings if you enable this feature

Minimum length: 1
​
email
string | null

Optional - Email address of the consumer. It can be used for sending automated reminders (if the feature is enabled) and deployment by mail of local agent (when on-premise connector).

​
internal_reference
string | null

Your internal reference for the client (e.g., customer ID or unique identifier in your system).

​
redirect_url
string | null

URL to redirect the user after completing the activation via our link. Useful for directing customers to a dynamic or personalized url. You can also set up a default static URL in Chift's back office for all consumers.

⌘I