Updates a customer journey entity

put

https://api.indigitall.com/v2/cs/journey/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

number

required

customer journey's id

Body Params

Customer Journey data payload

name

string

description

string

customer journey description

enabledFrom

date-time | null

This customer journey will be enabled from this date. The date format is ISO-8601. Ex: 2020-12-13T08:18:39.632Z

enabledTo

date-time | null

This customer journey will be enabled until this date. The date format is ISO-8601. Ex: 2020-12-13T08:18:39.632Z

enabledToMode

string | null

enum

Controls the behaviour of the journey once its enabledTo date has been reached.

soft (default) - New customers cannot enter the journey, but customers already
inside are allowed to continue and finish their flow naturally.
hard - Neither new customers can enter nor in-flight customers can continue
processing nodes — the journey is frozen immediately.

Requires enabledTo to be set.

Allowed:

waitQueueConfig

object | null

Configuration for the journey's wait queue. Only applicable for IN_LIST journeys.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated