v1

latestOpenAPI 3.0.32026-07-248003061.1 MB

Flows

Create or update flow by name

Create a new flow or update an existing one. When the body has no id, the name path param is used as the flow id.

post/flow/{name}

Path parameters

namestring required

The flow name (used as the flow id when the body has no id)

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

Request body

aidinteger

createdstring date-time

descriptionstring

entry_condition'in_segment' | 'on_segment_entry'

entry_segment_idstring

expires_atstring date-time

idstring

labelstring

modifiedstring date-time

reentry_allowedboolean

reentry_condition'in_segment' | 'on_segment_entry'

reentry_delayinteger

Nanoseconds to wait before a profile may re-enter the flow.

root_step_idinteger

state'draft' | 'running' | 'draining' | 'deleted'

state_modified_atstring date-time

versioninteger

Example request

{
  "steps": [
    {
      "delay_until": {
        "time_of_day": "09:30",
        "timezone": "America/New_York"
      }
    }
  ]
}

Response

Updated Flow

_metaobject

Response Metadata

request_idstring

statusinteger

HTTP Status Code

Example response

{
  "data": {
    "steps": [
      {
        "delay_until": {
          "time_of_day": "09:30",
          "timezone": "America/New_York"
        }
      }
    ]
  }
}