Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.

x-idempotency-expiration
string

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Body

application/json

Request body for POST /journeys/cancel. Provide EXACTLY ONE of cancelation_token (cancels every run associated with the token) or run_id (cancels a single tenant-scoped run).

cancelation_token
string
required
Minimum string length: 1

Response

Cancelation accepted

202 Accepted body for POST /journeys/cancel, returning the submitted identifier. When called with cancelation_token, returns { cancelation_token }; when called with run_id, returns { run_id, status }.

cancelation_token
string
required