Put a list of customers to a journey that is already running from a CSV file

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 endpoint may return an error.

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
file
required

A .csv file containing a list of customer IDs and optionally custom context fields.
Requirements:

  • The CSV must include a column with the header customerId, which contains the customer IDs you want to target.
  • You may include a column concurrencyExecutionId if the journey supports concurrency. If not provided, the system will generate a random for each customer.
  • You may include any other columns, which will be interpreted as dynamic context fields (contextKeys) with their corresponding values.

Example customer list:

  customerId,offerBank,subscriptionLevel
  be5d3f02f48647e2bd985128e1c4b065,300.00,premium
  be5d78f2f48647e2bd985128e1c4b066,256.00,basic
  be5d3f02a34547e2bd981234wqe34241,220.00,standard
  customerId,concurrencyExecutionId,offerBank
  be5d3f02a34547e2bd981234wqe34241,xyz789,220.00
  be5d3f02f48647e2bd985128e1c4b065,,300.00

Notes:

  • The order of columns does not matter, except that customerId is required.
  • Any column besides customerId and concurrencyExecutionId is treated as a dynamic context field.
Responses

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