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

curl --request PATCH \
  --url https://do.featurebase.app/v2/admins/{id}/assignment-limit \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 123,
  "mode": "inherit",
  "paused": true
}
'

{
  "adminId": "<string>",
  "effectiveLimit": 123,
  "limit": 123,
  "mode": "inherit",
  "object": "assignment_limit",
  "paused": true
}

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de ruta

idstringobligatorio

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Ejemplo: 2026-08-19.orbit

Cuerpo

limitinteger

Rango requerido: 1 <= x <= 1000000

modeenum<string>

Opciones disponibles: inherit, custom, unlimited

pausedboolean

Respuesta

Success

adminIdstringobligatorio

effectiveLimitinteger | nullobligatorio

limitinteger | nullobligatorio

modeenum<string>obligatorio

Opciones disponibles: inherit, custom, unlimited

objectenum<string>obligatorio

Opciones disponibles: assignment_limit

pausedbooleanobligatorio

¿Aún necesitas ayuda? Pregunta al equipo