PUT
/
v1
/
flows
/
{numericFlowId}

As this endpoint modifies data, you will need to use the private API key.

Only call this endpoint from your backend code.

Obtaining the numeric ID of a Flow

To obtain the numeric ID of a Flow, you should make a GET request to get the Flow you are looking to change. The numeric ID is a number and is different from the slug (e.g. flow_GzXC2fHz). The reason for this is that different versions of the Flow share the same slug but have different numeric IDs to differentiate them.

Authorizations

Authorization
string
header
required

Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which

Body

application/json
active
boolean

Whether the Flow is active or not. If set to false, the Flow will not be shown to users

data
string

JSON or YAML encoded raw data of thew Flow. If provided in JSON format it will be converted to YAML automatically

description
string

The description of the Flow

name
string

The name of the Flow

targetingLogic
string

The targeting logic for the Flow

type
enum<string>

The type of Flow

Available options:
ANNOUNCEMENT,
BANNER,
CARD,
CHECKLIST,
CUSTOM,
FORM,
SURVEY,
TOUR

Response

200 - application/json
codeSnippet
string

The original code snippet for the Flow when it was created

createdAt
string

The data the Flow was created in ISO 8601 format

data
string

JSON encoded raw data of the Flow as defined in the Flow's YAML configuration

id
number

The numeric ID of the Flow. This number will be different depending on the version used

modifiedAt
string

The data the Flow was last modified in ISO 8601 format

name
string

The name of the Flow

slug
string

A unique identifier for the Flow such as flow_abc. Slugs stay the same between environment and versions.

status
enum<string>

The status of the Flow

Available options:
ACTIVE,
ARCHIVED,
DRAFT
targetingLogic
string

The targeting logic for the Flow

type
enum<string>

The type of Flow

Available options:
ANNOUNCEMENT,
BANNER,
CARD,
CHECKLIST,
CUSTOM,
FORM,
SURVEY,
TOUR
version
number

The version of the Flow