Create a flow: a trigger and steps (wait, email, tag, condition)

Before you call

Credential

Authorization: Bearer $KEY

Scope

campaigns:write

Graphql

Mutation.campaignsFlowCreate

Sdk

campaigns.flow.create

Cli

campaigns flow create

Request bodyapplication/json, required

• namestringrequired
  At most 160 characters.
• triggerobjectrequired
  • eventstringrequired
    At most 60 characters. Pattern: ^[a-z_]+(.[a-z_]+){0,2}$.
  • matchobject
    • tagstring
      At most 40 characters. Pattern: ^[\p{L}\p{N}][\p{L}\p{N} _.:/-]*$.
    • channelstring
      One of: email, sms, whatsapp, phone.
    • purposestring
      Pattern: ^[a-z][a-z0-9_]{0,29}$.
    • formIdstring (uuid)
    • sourcestring
      At most 80 characters.
  • inactiveDaysinteger
    At least 7. At most 1095.
  • segmentIdstring (uuid)
• purposestring
  Default: marketing. Pattern: ^[a-z][a-z0-9_]{0,29}$.
• kindstring
  One of: marketing, service. Default: marketing.
• stepslist of objectrequired
• reenrollAfterDaysinteger or null
• exitOnlist of string

Responses

• 201application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring