Update authorized business settings

Updates business name and validated IANA time zone. No orders/schedules are implemented yet; future changes after schedules exist require the unresolved domain migration policy.

Authentication

Requires an authorized administrator bearer session; business membership rules apply. Do not assume an integration key can replace an account session.

Parameters

Request

Example JSON body

{
  "name": "Example Services",
  "time_zone": "Europe/Warsaw",
  "planning": {
    "travel_metric": "time",
    "objectives": [
      "completed_tasks",
      "travel"
    ],
    "location_freshness_seconds": 1800,
    "min_rest_seconds": 28800,
    "notify_unplanned": true
  },
  "evidence": {
    "require_photos": false,
    "require_signature": false
  },
  "routing": {
    "engine": "osrm",
    "update_schedule": "0 3 * * 0"
  }
}

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

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/settings' \
  --header 'Authorization: Bearer REPLACE_WITH_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Example Services","time_zone":"Europe/Warsaw","planning":{"travel_metric":"time","objectives":["completed_tasks","travel"],"location_freshness_seconds":1800,"min_rest_seconds":28800,"notify_unplanned":true},"evidence":{"require_photos":false,"require_signature":false},"routing":{"engine":"osrm","update_schedule":"0 3 * * 0"}}' \
  --output response.bin

Responses

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

200 · Selected business settings. Zone changes preserve existing UTC appointment instants.

application/json

{
  "id": "example-id",
  "name": "Example Services",
  "time_zone": "Europe/Warsaw",
  "planning": {
    "travel_metric": "time",
    "objectives": [
      "completed_tasks",
      "travel"
    ],
    "location_freshness_seconds": 1,
    "min_rest_seconds": 1,
    "notify_unplanned": false
  },
  "evidence": {
    "require_photos": false,
    "require_signature": false
  },
  "routing": {
    "engine": "osrm",
    "update_schedule": "example"
  }
}

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

400 · Axum extraction rejects invalid JSON/type, oversized body, or malformed UUID before the domain handler. These responses may be text/plain rather than the domain Error object.

text/plain

Binary response. Save the returned bytes to a file; do not parse as JSON.

401 · Invalid credentials, missing bearer token, or expired/unverified session.

application/json

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid credentials, missing bearer token, or expired/unverified session."
  }
}

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

404 · Business absent or not authorized for this account; no cross-business existence disclosure.

application/json

{
  "error": {
    "code": "not_found",
    "message": "Business absent or not authorized for this account; no cross-business existence disclosure."
  }
}

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

413 · Axum extraction rejects invalid JSON/type, oversized body, or malformed UUID before the domain handler. These responses may be text/plain rather than the domain Error object.

text/plain

Binary response. Save the returned bytes to a file; do not parse as JSON.

415 · Axum extraction rejects invalid JSON/type, oversized body, or malformed UUID before the domain handler. These responses may be text/plain rather than the domain Error object.

text/plain

Binary response. Save the returned bytes to a file; do not parse as JSON.

422 · Domain validation failure; names are trimmed and emails normalized.

application/json

{
  "error": {
    "code": "validation",
    "message": "Domain validation failure; names are trimmed and emails normalized."
  }
}

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

503 · Required persistence or credential operation unavailable.

application/json

{
  "error": {
    "code": "unavailable",
    "message": "Required persistence or credential operation unavailable."
  }
}

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