POST
/
businesses
/
{id}
/
triggers
Create a trigger
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/triggers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "trigger": "<string>",
  "name": "<string>",
  "filter": "<string>",
  "metadata": {},
  "attributed_revenue": 123,
  "steps": [
    {
      "type": "email",
      "custom_step_id": "<string>",
      "email_template_id": "<string>"
    }
  ],
  "email_address": "<string>",
  "phone_number": "<string>",
  "excluded_customers": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "trigger": "<string>",
  "steps": [
    {
      "type": "email",
      "custom_step_id": "<string>",
      "email_template_id": "<string>"
    }
  ],
  "status": "draft",
  "filter": "<string>",
  "email_address": "<string>",
  "phone_number": "<string>",
  "attributed_revenue": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Body

application/json

Response

200 - application/json

The created Trigger object

The response is of type object.