Skip to main content
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
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
awayReasonIdstring | null
enabledbooleanrequired
reassignRepliesboolean

Response

application/json

Success

adminIdstringrequired
automaticbooleanrequired
awaybooleanrequired
changedAtstring | nullrequired
lastActiveAtstring | nullrequired
objectenum<string>required
Available options: admin_availability
reasonobject | nullrequired
reassignRepliesbooleanrequired