Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Consumers

Update one consumer

Update one consumer in Chift

patch/consumers/{consumer_id}

Path parameters

consumer_idstring uuid required

Request body

namestring nullable

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.

emailstring nullable

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).

internal_referencestring nullable

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

redirect_urlstring nullable

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.

Response

Successful Response

consumeridstring uuid required

Unique id of the consumer in Chift

namestring 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

emailstring nullable

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_referencestring nullable

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

redirect_urlstring nullable

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.