Publish reviewed planning/status changes

Atomic protected-plan validation: stale changes to live in-progress work block the affected publication; explicit administrator lifecycle override is allowed subject to invariants. Warned manual plans require acknowledgement. order_ids permits publishing pending statuses for unplanned orders with no route. Confirmed cancellation releases capacity at publication; unscheduling already released it earlier. Integration permission: planning.publish. Administrator membership grants management access only to this business.

Authentication

Authorized business administrator session, or a business API key with planning.publish.

Parameters

Request

Example JSON body

{
  "plan_ids": [
    "plan-01"
  ],
  "expected_revision": [
    {
      "id": "plan-01",
      "revision": 1
    }
  ],
  "acknowledge_warnings": false
}

{
  "type": "object",
  "properties": {
    "plan_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "order_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expected_revision": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "revision": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "revision"
        ]
      }
    },
    "acknowledge_warnings": {
      "type": "boolean"
    }
  }
}

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/plans/publish' \
  --header 'Authorization: Bearer REPLACE_WITH_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"plan_ids":["plan-01"],"expected_revision":[{"id":"plan-01","revision":1}],"acknowledge_warnings":false}'

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