# Publish a Route draft `POST /v2/routes/{id}/draft/publish` Core API v2, Routes. Publish the Route's draft as a new version and delete the draft. The draft's tree must pass every check Publish a Route version applies. If it does not, nothing is published and the draft is kept. Unless `activate` is `true`, the Route's active version stays as it is. Send the draft's `revision` you reviewed, so a draft saved after you read it is not published. **Authentication:** Send `Authorization: Bearer `. To authenticate, generate a Secret API Key from your ODUS Dashboard and include it in the `Authorization` header as follows: `Authorization: Bearer ` ## Parameters ### Path parameters - `id` (string, required) ## Request body Content type `application/json`, required. Type: object (PublishRouteDraftRequestDTO). - `revision` (integer): The `revision` of the draft you reviewed. When you send it and the draft's current `revision` is different, or the Route has no draft, nothing is published, the draft is kept and the request is refused with `409`. `0` means you expect no draft, so it is refused with `409` whenever the Route has one. Leave it out to publish the draft whatever its revision. Minimum 0. Maximum 9007199254740991. - `activate` (boolean): Make the new version the active one as soon as it is published. When `false` or omitted, the active version stays as it is. ## Responses ### `201` OK Type: object (RouteVersionDTO). - `createdAt` (string (date-time), required): The date and time when the entity was created. Example: `2024-02-18T12:00:00Z`. - `updatedAt` (string (date-time), required, nullable): The date and time when the entity was last updated. Example: `2024-02-21T12:15:00Z`. - `metadata` (map of string to string, nullable): Metadata used by merchants to store additional information about the entity. - `id` (string, required): The unique identifier of the route version. Example: `rtv_2mXGTxXIkqv4uSdbm8DJCzvHUIu`. - `route` (string, required): The ID of the route this is a version of. Example: `rte_2mXGTxXIkqv4uSdbm8DJCzvHUIu`. - `number` (integer, required): The version's number. A route's first version is 1, and each version published after it counts up by one. Minimum -9007199254740991. Maximum 9007199254740991. Example: `2`. - `tree` (object, required): The version's decision tree, exactly as it was published: the same shape as `tree` in Publish a Route version. It never changes once published. ### `202` The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway. Type: object (ProvisioningInProgress). - `status` (string, required): Signals the merchant environment is still being provisioned. One of `provisioning`. - `merchantAccountId` (string, required): The merchant account whose environment is being provisioned. Example: `dAI3aa87ROOeupeBCjNSKCOBOisBCYjB`. ### Errors - `400`: The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; or `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it. - `401`: No API key was supplied, or the key is not valid. `type` is `authentication_error`. - `403`: The API key is valid but lacks the permission this operation requires. `type` is `permission_error`. - `404`: No resource exists with the requested identifier. `type` is `not_found_error`. - `409`: `type` is `conflict_error`. The supplied `X-Idempotency-Key` was already used with a different request body (`code` is `idempotency_conflict`, and retrying will not help), or the resource is being modified by another in-flight request (`code` is `resource_locked`, and retrying with backoff will). It is also answered when you send `revision` and the draft is at a different revision, the Route has no draft, or you sent `0` and the Route has a draft (`code` is `stale_revision`). Nothing is published, the active version stays as it is and the draft is kept. Retrying will not help: read the draft again and check it before you publish its current `revision`. - `429`: Too many requests. A limit applies per operation; requests to other operations are unaffected. `type` is `rate_limit_error`. Use the `Retry-After-global` header to know when to retry. - `500`: The request could not be completed because of an unexpected error. `type` is `api_error`. - `503`: The request could not be served right now: the API is temporarily at capacity, or a dependency needed to authorize the request is unavailable — the auth service that verifies credentials, or the entitlement lookup behind it. `type` is `api_error`. It is raised before the operation runs, so the request had no effect, and unlike a plain 500 the condition is transient: retry with backoff. - `504`: The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly. Every error response has the same body: see [Errors](https://docs.odus.com/docs/guides/api-features/errors.md). --- Generated from the Core API v2 OpenAPI document, https://api.odus.com/openapi.v2.json. Interactive page: https://docs.odus.com/docs/api/core/v2/route-controller-publish-draft