Register APNs/FCM device for published-plan notifications

Driver session only; APNs token requires even-length hexadecimal. Push transport requires deployment credentials; registering a token is not proof of delivery/receipt. Driver refresh remains authoritative.

Authentication

Requires a driver bearer session. Administrator sessions and integration keys cannot perform this driver action.

Parameters

No path or query parameters.

Request

Example JSON body

{
  "provider": "apns",
  "device_token": "example"
}

{
  "type": "object",
  "properties": {
    "provider": {
      "enum": [
        "apns",
        "fcm"
      ]
    },
    "device_token": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "provider",
    "device_token"
  ]
}

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/driver/push-devices' \
  --header 'Authorization: Bearer REPLACE_WITH_DRIVER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"provider":"apns","device_token":"example"}'

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 · Invalid/revoked driver session

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid/revoked driver session"
  }
}

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

403 · Required driver permission denied

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Required driver permission denied"
  }
}

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

404 · Not found in own business

application/json

{
  "error": {
    "code": "not_found",
    "message": "Not found in own business"
  }
}

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

422 · Validation failed

application/json

{
  "error": {
    "code": "validation",
    "message": "Validation failed"
  }
}

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

503 · Required infrastructure unavailable

application/json

{
  "error": {
    "code": "unavailable",
    "message": "Required infrastructure unavailable"
  }
}

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