put
https://api.vcita.biz/platform/v1/clients/bulk
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:
trueorfalse(automatically converted to"1"or"0")
- String values:
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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
401Unauthorized - Invalid or missing authentication token
