API documentation | API docs for agents | OpenAPI 3.1

backup-users

ark.set_user_backup_users

Replaces a broker user's backup-user assignments for absence coverage and outgoing email CC workflows. Requires tenant-admin access and admin:write.

Availability: Expanded preview
Scopes: admin:write
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

userIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

backupUserIdsarray<string>required

Replacement backup user IDs. Use an empty array to clear all backup users.

max items: 50

Example request

Shell

curl -X PUT 'https://arktms.com/api/v1/users/<userId>/backup-users' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "backupUserIds": [
    "<backupUserIds>"
  ]
}'

Success response

Updated user backup users

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.userIdstringrequired

format: uuid

data.backupUsersarray<object>required

data.addedBackupUserIdsarray<string>required

data.removedBackupUserIdsarray<string>required

data.messagestringrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry