Skip to main content
Workload

Update an admin assignment limit

Updates the admin capacity mode or paused state. mode can be inherit, custom, or unlimited. custom requires limit. Omitted fields keep their current value.

PATCH
/v2/admins/{id}/assignment-limit
Authorizationstringheaderrequired

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

idstringrequired
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
limitinteger
Required range: 1 <= x <= 1000000
modeenum<string>
Available options: inherit, custom, unlimited
pausedboolean

Response

application/json

Success

adminIdstringrequired
effectiveLimitinteger | nullrequired
limitinteger | nullrequired
modeenum<string>required
Available options: inherit, custom, unlimited
objectenum<string>required
Available options: assignment_limit
pausedbooleanrequired