Start the step the run is parked in front of

post

https://example.com/v1/cases/{id}/actions/resume

About this API

To get the ins and outs of this API, please refer to our documentation page here

Service limitations

To ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.

How to use this page?

Pick a preferred language on the right.
Enter your API key in the header field. Don't have one yet or don't know what that is? Please refer to the following page here.
Enter the required parameters below or try something yourself!
Click the Try It! button!

📘
You can also click one of the HTTP response codes at the bottom to see an example of that specific response!

Path Params

uuid

required

Case id (uuid). A non-uuid value yields 400 invalid_id with source.parameter id.

Body Params

Body of POST /v1/cases/{id}/actions/resume. type is the step type
spelled exactly as stored in step_executions.step_type — kebab-case,
echoed verbatim from the offered case-plane item; there is no second,
action-side spelling to translate (ADR-0041 §4). No actor member exists
and none is accepted: identity comes from the gateway headers and the
API resolves it to users.id itself (ADR-0032, ADR-0041 §3). Unknown
members are ignored, not rejected.

data

object

required

Headers

Idempotency-Key

uuid

Accepted and ignored on the bar actions, never required: a repeated resume reaches a step that is already running and does nothing, so the state machine is the deduplication (ADR-0041 §3). A client may still mint one per click; nothing depends on it and the response is identical with or without it.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

202Signal accepted by the case workflow. Carries the composed case view and meta.signal.

400Undecodable JSON body (title invalid_json), or a non-uuid case id (title invalid_id, source.parameter id).

401Missing CI-Subject-URN or CI-Request-Id, absent CI-Role header, or a subject URN not provisioned as a KYC user (title unauthenticated, source.header names the offending header).

404The resource does not exist — or belongs to another tenant, which is indistinguishable (title not_found).

422Absent body, missing or blank type, a wrong-typed type, or a data.type other than case-actions — title validation_failed, one entry per violation, source.pointer naming the offending member (e.g. /data/attributes/type).

500Unexpected server error (title internal_error).

503The action was valid but could not be delivered — no Temporal is configured at this tier (ADR-0013) or the server is unreachable (title workflow_unavailable). The case did not move on; retry shortly.