Entity description
A ClientSettings entity represents a set of settings for a client, like opt-out. It is created automatically as part of the client creation but can be updated separately using the update endpoint.
Properties
| Name | Description | Type | Example |
|---|---|---|---|
| client_uid | The unique identifier (UID) of the client | string | d290f1ee-6c54-4b01-90e6-d701748f0851 |
| opt_out_transactional_sms | Indicates whether the client has opted out of transactional SMS | boolean | true |
| created_at | The timestamp when the record was created (ISO 8601 format) | string | 2021-07-20T14:00:00.000Z |
| updated_at | The timestamp when the record was last updated (ISO 8601 format) | string | 2021-07-20T14:00:00.000Z |
Example
{
"client_uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"opt_out_transactional_sms": true,
"created_at": "2021-07-20T14:00:00.000Z",
"updated_at": "2021-07-20T14:00:00.000Z"
}