AIairship
Journeys

Enter or exit a Sequence

Changed on

Enters an audience segment into a Sequence identified by triggering_id, or exits one from it. If multiple Sequences share a triggering_id, the call enters or exits audiences in all of them. Use entrance_id to run multiple concurrent, independent instances of the Sequence for the same users without overwriting earlier enrollments.

post/api/journeys/trigger

Request

Request body

entrance_idstring

A unique identifier for enrolling the same users in multiple concurrent, independent instances of a Sequence. Each call with a different entrance_id creates a new enrollment without overwriting earlier ones.

global_attributesobject

The global attributes object may contain an arbitrary set of keys and values, including arrays and nested objects, which will be used for personalization of triggered pushes. Top-level keys cannot start with the reserved prefix ua_.

Response

Returned if the 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