Ir al contenido principal
Workload

Update admin away state

Updates an admin away state. awayReasonId uses a stable managed-reason ID. Omit it to preserve the current reason, or send null to clear the reason.

PATCH
/v2/admins/{id}/away
Authorizationstringheaderobligatorio

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

idstringobligatorio
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

application/json
awayReasonIdstring | null
enabledbooleanobligatorio
reassignRepliesboolean

Respuesta

application/json

Success

adminIdstringobligatorio
automaticbooleanobligatorio
awaybooleanobligatorio
changedAtstring | nullobligatorio
lastActiveAtstring | nullobligatorio
objectenum<string>obligatorio
Opciones disponibles: admin_availability
reasonobject | nullobligatorio
reassignRepliesbooleanobligatorio