FRfrigadehq
flows

PUT /v1/flows/{numericFlowId}

Update a Flow's configuration and metadata

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namestring

The name of the Flow

datastring

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

descriptionstring

The description of the Flow

targetingLogicstring

The targeting logic for the Flow

type'ANNOUNCEMENT' | 'BANNER' | 'CARD' | 'CHECKLIST' | 'CUSTOM' | 'FORM' | 'SURVEY' | 'TOUR'

The type of Flow

activeboolean

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

Example request

{
  "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
}

Response

The flow has been successfully updated.

idnumber

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

namestring

The name of the Flow

datastring

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

targetingLogicstring

The targeting logic for the Flow

type'ANNOUNCEMENT' | 'BANNER' | 'CARD' | 'CHECKLIST' | 'CUSTOM' | 'FORM' | 'SURVEY' | 'TOUR'

The type of Flow

slugstring

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

createdAtstring date-time

The data the Flow was created in ISO 8601 format

modifiedAtstring date-time

The data the Flow was last modified in ISO 8601 format

versionnumber

The version of the Flow

status'ACTIVE' | 'ARCHIVED' | 'DRAFT'

The status of the Flow

codeSnippetstring

The original code snippet for the Flow when it was created

Example response

{
  "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\" />"
}

Changes

No recorded changes to this operation across all 1 revision of this API.