v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-012366102.8 KB

User Journeys

Rescind Multiple User Journeys

Rescind all rescindable journeys for a user, optionally filtered by transition type. transition_type accepts a comma-separated list and spaces after commas are allowed.

patch/api/v2/user_journeys/rescind

Request body

transition_typestring

Optional comma-separated list of transition types. Spaces after commas are allowed. Allowed values are pre_offer, offer, post_offer, onboarding, offboarding.

rescind_reason'no_longer_needed' | 'offered_externally' required

user_idstring required

ID of the user whose journeys will be rescinded.

Example request

{
  "transition_type": "pre_offer, offer, post_offer, onboarding, offboarding",
  "rescind_reason": "no_longer_needed",
  "user_id": "6949f4dcea80bfa3cb3c21d7"
}

Response

There is no content to send for this request, but the headers may be useful.