Update client settings

POSThttp://localhost:4000/api/clientsSettings/update

Changes the client settings of your organization. Turning off duplicateBehaviorEnabled also clears the two related settings.

Your API key needs the clients.CONFIGURE_SETTINGS permission.

Body Params

sendClientWelcomeEmailboolean

Send a welcome email to each new client.

duplicateBehaviorEnabledboolean

React when an existing client signs up again.

duplicateBehaviorSendEmailEnabledboolean

Email the owning agent when an existing client signs up again.

duplicateBehaviorChangeStageToIdinteger

Move a returning client to this stage.

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/clientsSettings/update \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"sendClientWelcomeEmail":true}'

Response

Click Try It! to send a request and see the response here, or choose an example: