Skip to main content
POST
/
{channelId}
/
workflows
/
{workflowId}
Start workflow
curl --request POST \
  --url https://api.heyy.io/api/v2.0/{channelId}/workflows/{workflowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phoneNumber": "<string>",
  "variables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "scheduledAt": "2023-11-07T05:31:56Z"
}'
{
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
channelId
string
required
​
workflowId
string
required

Body

application/json
​
phoneNumber
string
required
​
variables
object[]
​
scheduledAt
string<date-time>

Response

200 - application/json
​
data
object
required