Skip to main content
Workload

Bulk update admin workload state

Atomically updates away state or assignment limits for up to 50 admins. One request performs one operation type. Assignment-limit operations require an explicit paused value.

PATCH
/v2/admins/bulk
Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Body

application/json

Response

application/json

Success

dataobject[]required
objectenum<string>required
Available options: bulk_result
operationenum<string>required
Available options: away, assignment_limit
updatedCountintegerrequired
Required range: 0 <= x