Bulk Update Client Settings

Overview

Bulk update client settings for multiple clients in a single operation. Supports partial success - individual clients can fail while others succeed.

Currently Supported Field

This endpoint currently supports updating only the opt_out_transactional_sms field. Any request containing other fields will be rejected with a validation error.

Field Requirements

  • opt_out_transactional_sms must be an explicit boolean value (true or false)
  • null values are not allowed
  • Missing the field will cause validation failure

Limits

  • Maximum 1000 clients per request
  • Duplicate client UIDs are not allowed

Authentication

Available for Staff Tokens only.

Client tokens should use the single update endpoint /v3/clients/client_settings/{client_uid} instead.

Response Behavior

  • Returns HTTP 200 with an array of results (one per client)
  • Each result includes a success boolean and either data (on success) or errors (on failure)
  • Individual client failures (e.g., not found) do not prevent other clients from being updated
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
client_settings
array of objects
required
length ≤ 1000

Array of client settings to update (max 1000)

client_settings*
Responses

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