Send a flow message

POST/v1/messages/flow

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

bodystringrequired

Body text

min length 1

channel_idstringrequired

Channel ID

min length 1

flow_actionstring

Flow action (default: navigate)

flow_ctastringrequired

Flow CTA button text

min length 1

flow_dataobject

Flow action payload data

flow_idstringrequired

Flow ID

min length 1

flow_screenstring

Flow screen name

flow_tokenstring

Flow token

footerstring

Optional footer text

headerInteractiveHeaderContent

Optional header

Show properties

file_namestringrequired

linkstringrequired

media_idstringrequired

media_urlstringrequired

textstringrequired

typestringrequired

urlstringrequired

tostringrequired

Recipient phone number

min length 1

Responses

201Created

message_idstring

statusstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/messages/flow" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string",
  "channel_id": "string",
  "flow_action": "string",
  "flow_cta": "string",
  "flow_data": {},
  "flow_id": "string",
  "flow_screen": "string",
  "flow_token": "string",
  "footer": "string",
  "header": {
    "file_name": "string",
    "link": "string",
    "media_id": "string",
    "media_url": "string",
    "text": "string",
    "type": "string",
    "url": "string"
  },
  "to": "string"
}'

const response = await fetch("/v1/messages/flow", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "body": "string",
  "channel_id": "string",
  "flow_action": "string",
  "flow_cta": "string",
  "flow_data": {},
  "flow_id": "string",
  "flow_screen": "string",
  "flow_token": "string",
  "footer": "string",
  "header": {
    "file_name": "string",
    "link": "string",
    "media_id": "string",
    "media_url": "string",
    "text": "string",
    "type": "string",
    "url": "string"
  },
  "to": "string"
})
});

import requests

response = requests.post(
    "/v1/messages/flow",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "body": "string",
  "channel_id": "string",
  "flow_action": "string",
  "flow_cta": "string",
  "flow_data": {},
  "flow_id": "string",
  "flow_screen": "string",
  "flow_token": "string",
  "footer": "string",
  "header": {
    "file_name": "string",
    "link": "string",
    "media_id": "string",
    "media_url": "string",
    "text": "string",
    "type": "string",
    "url": "string"
  },
  "to": "string"
},
)

Response

{
  "message_id": "string",
  "status": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}