POST /api/v1/lifecycles/{entity_name}/{guid}/advance

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Advance

Advance a record via an outlet (analog of Entherium’s advance_record).

Auth: Authorization: Bearer <token> required

Request

curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/lifecycles/<entity_name>/<guid>/advance" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"detail":{"note":"verified live"},"outlet":"ok"}'

Response `200`

The contract carries no example for this response; schema: AdvanceResponse. Field-level shape: interactive explorer.

Returns

AdvanceResponse — Successful Response

Field	Type	Description
`detail`	`object \| null` (opt.)
`entity`	`string`
`from_step`	`integer \| null`
`guid`	`integer`
`outlet`	`string`
`to_step`	`integer`

Parameters

Parameter	In	Required	Type	Default	Constraints	Description
`entity_name`	path	yes	`string`	—	—
`guid`	path	yes	`integer`	—	—
`Idempotency-Key`	header	no	`string`	—	uuid	Optional.

Request body

Field	Type	Required	Description
`detail`	`object \| null`	no
`outlet`	`string`	yes	Outlet name (ok, error, or conditional name)

Example:

{
  "detail": {
    "note": "verified live"
  },
  "outlet": "ok"
}

Errors

Code	Meaning	Body
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`404`	Entity or lifecycle not found	`ErrorResponse`
`409`	Transition not allowed from the current step	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.