Update Flow
Update a Flow’s configuration and metadata
As this endpoint modifies data, you will need to use the private API key.
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
Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which
Body
The name of the Flow
JSON or YAML encoded raw data of thew Flow. If provided in JSON format it will be converted to YAML automatically
The description of the Flow
The targeting logic for the Flow
The type of Flow
ANNOUNCEMENT, BANNER, CARD, CHECKLIST, CUSTOM, FORM, SURVEY, TOUR Whether the Flow is active or not. If set to false, the Flow will not be shown to users
Response
The numeric ID of the Flow. This number will be different depending on the version used
The name of the Flow
JSON encoded raw data of the Flow as defined in the Flow's YAML configuration
The targeting logic for the Flow
The type of Flow
ANNOUNCEMENT, BANNER, CARD, CHECKLIST, CUSTOM, FORM, SURVEY, TOUR A unique identifier for the Flow such as flow_abc. Slugs stay the same between environment and versions.
The data the Flow was created in ISO 8601 format
The data the Flow was last modified in ISO 8601 format
The version of the Flow
The status of the Flow
ACTIVE, ARCHIVED, DRAFT The original code snippet for the Flow when it was created