Put a list of customers to a journey that is already running

Put a list of customers to a journey that is already running

The customer journey must have an IN state of type IN_LIST

If any of the customers is already in the journey, the system will discard that customer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

journey id

Query Params
boolean
Defaults to false

Run the journey with a list of customers in test mode.

The journey must be in IDLE mode.

Body Params
customers

Can be either:

  • Deprecated: array of string customer IDs.
  • Array of customer objects with context (preferred).

Only customers OR customersWithContext should be provided.

customersWithContext
array of objects
deprecated

Deprecated: Instead use customers with array of objects. List of customers with context data. Each object must contain a customerId (alphanumeric string) and a contextValues object with key-value pairs representing dynamic context fields.

Only one of customers or customersWithContext should be provided per request.
Example:

  {
    "customerId": "be5d3f02f48647e2bd985128e1c4b065",
    "contextValues": {
      "offerBank": "300.00",
      "subscriptionLevel": "premium"
    }
  },
  {
    "customerId": "be5d78f2f48647e2bd985128e1c4b066",
    "contextValues": {
      "offerBank": "220.00",
      "subscriptionLevel": "basic"
    }
  }
] ```
customersWithContext
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json