PUT
/
v1
/
flows
/
{numericFlowId}
cURL
curl --request PUT \
  --url https://api.frigade.com/v1/flows/{numericFlowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "New User Announcement",
  "data": "{\"steps\": [{\"id\": \"step_1\", \"title\": \"Welcome to my app!\", \"subtitle\": \"Let me show you around.\"}]}",
  "description": "This is a Flow that welcomes new users to the app",
  "targetingLogic": "user.property('\''isAdmin'\'') == true",
  "type": "CHECKLIST",
  "active": true
}'
{
  "id": 123,
  "name": "New User Announcement",
  "data": "{\"steps\": [{\"id\": \"step_1\", \"title\": \"Welcome to my app!\", \"subtitle\": \"Let me show you around.\"}]}",
  "targetingLogic": "user.property('isAdmin') == true",
  "type": "CHECKLIST",
  "slug": "flow_abc",
  "createdAt": "2024-01-01T00:00:00Z",
  "modifiedAt": "2024-01-01T00:00:00Z",
  "version": 1,
  "status": "ACTIVE",
  "codeSnippet": "<Frigade.Announcement flowId=\"my-flow-id\" />"
}
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

Response

200 - application/json

The flow has been successfully updated.

The response is of type object.