Skip to content

Publish the draft as the next immutable version

POST
/v1/plans/{plan_key}/publish
curl --request POST \
--url https://api.seal0.app/v1/plans/example/publish \
--header 'Authorization: Bearer <token>'
plan_key
required
string
Idempotency-Key
string
>= 1 characters <= 255 characters

Optional; replays the stored response for 24 hours.

The published version.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string
plan_key
required

Feature or plan key.

string
/^[a-z][a-z0-9_]{0,63}$/
published_at
required
string format: date-time
nullable
status
required
string
values
required
object
key
additional properties
One of:
boolean
version
required

Null while draft.

integer
nullable

Example generated

{
"created_at": "2026-04-15T12:00:00Z",
"id": "example",
"plan_key": "example",
"published_at": "2026-04-15T12:00:00Z",
"status": "example",
"values": {
"additionalProperty": true
},
"version": 1
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}