API documentation | API docs for agents | OpenAPI 3.1

{personId}

ark.update_person

Updates a carrier driver or dispatcher contact profile and optional carrier link.

Availability: Core preview
Scopes: people:write
ARK permissions: canEditPerson
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

personIdpathstringrequired: Underlying ARK person ID.; 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

typestringrequired

one of: driver, dispatcher

carrierIdstring

Carrier ID this driver or dispatcher contact belongs to.

format: uuid

firstNamestring | null

max length: 100

lastNamestring | null

max length: 100

emailstring | null

max length: 500

phonestring | null

max length: 50

notesstring | null

max length: 5000

Example request

Shell

curl -X PATCH 'https://arktms.com/api/v1/people/<personId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "driver"
}'

Success response

Updated person

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.typestringrequired

one of: driver, dispatcher

data.recordIdstringrequired

Driver or dispatcher table record ID.

format: uuid

data.personIdstringrequired

Underlying ARK person ID used for get/update/delete.

format: uuid

data.firstNamestring | nullrequired

data.lastNamestring | nullrequired

data.emailstring | nullrequired

data.phonestring | nullrequired

data.notesstring | nullrequired

data.carrierobject | nullrequired

data.hasAppAccountboolean | nullrequired

Driver mobile-app account flag. Null for dispatchers.

data.userIdstring | nullrequired

format: uuid

data.createdAtstring | nullrequired

format: date-time

data.modifiedAtstring | nullrequired

format: date-time

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found