Abandon a pathway execution | CAIL Health

Marks a pathway execution as abandoned mid-flow. The body is optional indefinitely: legacy clients calling without a body remain supported. Supplied fields refine drop-off analytics but are not required. Returns the lifecycle envelope reflecting the abandoned state.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Stable identifier of the pathway execution.

Request

This endpoint expects an object.

reasonCodestringOptional<=64 characters

Opaque reason for abandonment, captured for analytics only. Engine ignores the value.

Response

The envelope after abandonment.

envelopeobject

Lifecycle envelope reflecting the updated execution.

$	curl -X POST https://staging.cail.health/v1/pathway-executions/2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f/abandon \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"envelope": {
3	"id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
4	"planDefinitionId": "a1b2c3d4-e5f6-4789-9abc-def012345678",
5	"planDefinitionVersionId": 42,
6	"channel": "voice",
7	"status": "abandoned",
8	"startedAt": "2026-05-13T14:21:00.000Z",
9	"endedAt": "2026-05-13T14:21:45.000Z"
10	}
11	}