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

post

https://sandbox.crmcarecloud.com/webservice/rest-api/customer-interface/v1.0/tokens/{token_id}/actions/send-password-setup-email

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 Customer API.
⚠️ 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

token_id

string

required

A client application token.

Body Params

string

deprecated

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 APIs.If possible do not use it.

communication_channel_id

string

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.

recipient

string

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.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

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

Responses

204

No Content

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The request path does not match any API route, or the addressed resource does not exist.

405The request path matches a valid route, but the endpoint does not support the HTTP method used in the request.

500Server is not working as expected.