API Reference

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

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/tokens//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 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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 API.If possible do not use it.

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.

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

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago