v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Tokens

Send the message for the setup of a new customer's password

Send a message, that contains a link to set up a new customer password. The use case Forgotten password shows how to use this action method. ⚠️ Endpoint is available only in the Customer interface. ⚠️ An extra setup of the Marketing Automation scenario in CareCloud could be necessary to make the endpoint work correctly. If so, don't hesitate to get in touch with the CareCloud administrator in your organization.

post/tokens/{token_id}/actions/send-password-setup-email

Path parameters

token_idstring required

A client application token.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

emailstring

Message with a setup password link will be delivered to this email address.

⚠️This parameter is deprecated and will be removed in the future versions of CareCloud API.If possible do not use it.

communication_channel_idstring

ID of communication channels that will be used for password setup. Parameter is required if email parameter is not set.The list of all available channels is provided here: GET /communication-channels

The possibility of a password setup message from a channel may vary depending on the project setup. For more information, please contact the CareCloud administrator.

recipientstring

Recipient of the message with a password setup. The value of a parameter depending on communication_channel_id. Parameter is required if email parameter is not set.

Example request

{
  "email": "happy_customer@carecloud.com",
  "communication_channel_id": "86e05affc7a7abefcd513ab400",
  "recipient": "happy_customer@crmcarecloud.com"
}

Response

No Content