Add verified account or email administrator invitation

A verified existing account gains own-business membership; a new identity receives a24h setup invitation. No plaintext password is assigned. At least one administrator must remain. Integration permission: accounts.manage. Administrator membership grants management access only to this business.

Authentication

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

Parameters

Request

Example JSON body

{
  "email": "dispatcher@example.com",
  "display_name": "Alex"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    },
    "display_name": {
      "type": "string"
    }
  },
  "required": [
    "email"
  ]
}

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 POST 'https://route-api.okok.space/api/v1/businesses/11111111-1111-4111-8111-111111111111/admins' \
  --header 'Authorization: Bearer REPLACE_WITH_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"email":"dispatcher@example.com","display_name":"Alex"}'

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

{
  "id": "example-id",
  "created_at": "2026-11-02T09:00:00Z",
  "updated_at": "2026-11-02T09:00:00Z",
  "revision": 1,
  "deleted_at": "2026-11-02T09:00:00Z",
  "deleted_by": "11111111-1111-4111-8111-111111111111"
}

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

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"
}