Update admins

This is a managed resource: generic creation or updates are rejected. Use the dedicated workflow. Resource-dependent: orders.read/write; schemas=settings.read/write; drivers=accounts.manage; webhooks=integrations.manage; scenarios=scenarios.read/write; plans=planning.read; others=resources.read/write. PUT/PATCH merge supplied editable fields; system identity/metadata and actual execution timestamps cannot be overwritten. Deleted records are read-only; delete actions use soft deletion and enforce active-work/publication protections. Working-hour updates use the preview/apply workflow. Driver deactivation immediately revokes business-specific access without changing active work.

Authentication

Authorized business administrator session, or a business API key with accounts.manage.

Parameters

Request

Example JSON body

{
  "email": "colleague@example.com",
  "display_name": "Taylor"
}

{
  "$ref": "#/components/schemas/Record"
}

Example request

Replace synthetic identifiers and credentials. Example dates, coordinates, revisions, and IDs are not production defaults. Read the workflow guide before making a write.

curl --request PUT 'https://route-api.okok.space/api/v1/businesses/11111111-1111-4111-8111-111111111111/admins/job-1001' \
  --header 'Authorization: Bearer REPLACE_WITH_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"email":"colleague@example.com","display_name":"Taylor"}'

Responses

Examples illustrate the documented shape; optional fields and current state can differ. JSON extraction/body-limit errors may be plain text.

200 · Successful response

application/json

{
  "email": "colleague@example.com",
  "display_name": "Taylor"
}

{
  "$ref": "#/components/schemas/ResourceRecord"
}

401 · Missing/invalid/revoked token

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Missing/invalid/revoked token"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

403 · Business membership or required API-key scope denied

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Business membership or required API-key scope denied"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

404 · Record not found in authorized business

application/json

{
  "error": {
    "code": "not_found",
    "message": "Record not found in authorized business"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

409 · Duplicate identifier, stale revision, expired reservation, protected publication or unavailable capacity

application/json

{
  "error": {
    "code": "conflict",
    "message": "Duplicate identifier, stale revision, expired reservation, protected publication or unavailable capacity"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

422 · Domain validation rejected the operation

application/json

{
  "error": {
    "code": "validation",
    "message": "Domain validation rejected the operation"
  }
}

{
  "$ref": "#/components/schemas/Error"
}

503 · Required persistence, map/routing or other infrastructure unavailable

application/json

{
  "error": {
    "code": "unavailable",
    "message": "Required persistence, map/routing or other infrastructure unavailable"
  }
}

{
  "$ref": "#/components/schemas/Error"
}