AIairship
Journeys

Exit in-flight users from a Sequence

Changed on

Exits in-flight users from a Sequence identified by triggering_id. Specify an entrance_id to exit only users from that specific entrance, or omit it to exit users that entered without an entrance_id. This is a potentially long-running, asynchronous operation.

post/api/journeys/exit

Request

Request body

entrance_idstring

Identifies a specific entrance for exit. If provided, only users that entered with this entrance_id are exited. If omitted, only users that entered without an entrance_id are exited.

Response

Returned if the exit request has successfully been sent. This does not indicate that an existing Sequence successfully received the request.

okboolean required

Success.

operation_idstring uuid

A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple push_id strings, but a single operation_id) or operations that change an existing resource.

Changes