API documentation | API docs for agents | OpenAPI 3.1

invite

ark.invite_user

Invites a broker user or reactivates an inactive organization user, assigning teams in the same admin action. 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

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

emailstringrequired

format: email; max length: 320

firstNamestringrequired

min length: 2; max length: 100

lastNamestringrequired

min length: 2; max length: 100

teamIdsarray<string>

min items: 1; max items: 100

defaultTeamIdstring

format: uuid

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/users/invite' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "<email>",
  "firstName": "<firstName>",
  "lastName": "<lastName>"
}'

Success response

Invited or reactivated user

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.userIdstringrequired

format: uuid

data.emailstringrequired

format: email

data.firstNamestringrequired

data.lastNamestringrequired

data.activebooleanrequired

one of: true

data.reactivatedbooleanrequired

data.teamIdsarray<string>required

data.defaultTeamIdstringrequired

format: uuid

data.teamsarray<object>required

data.messagestringrequired

Errors

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