Bulk Update Clients

Overview

Bulk update client marketing opt-in status for multiple clients in a single operation.

Currently Supported Field

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

Field Format

  • opt_in - Marketing opt-in status. Accepts:
    • String values: "1" (opted-in) or "0" (opted-out)
    • Boolean values: true or false (automatically converted to "1" or "0")

Limits

  • Maximum 1000 clients per request
  • All clients must belong to the authenticated business
  • Duplicate client IDs are not allowed

Authentication

Available for Staff, App, and Directory tokens.

Behavior

  • Atomic operation - either all clients update successfully or the request fails
  • If any client is not found or validation fails, no clients are updated
  • If the business doesn't have an opt-in field configured, returns success with updated: false
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
clients
array of objects
required
length between 1 and 1000

Array of client updates. Maximum 1000 clients.

clients*
string
required

Client UID

string
required

Marketing opt-in status. Accepts "1", "0", true, or false.

Responses

401

Unauthorized - Invalid or missing authentication token

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