Skip to main content
POST
/
campaigns
/
{id}
/
check_sendability
Check the sendability of a campaign
curl --request POST \
  --url https://api.pocketflows.com/campaigns/{id}/check_sendability \
  --header 'Authorization: Basic <encoded-value>'
{
  "sendable": true,
  "errors": {
    "business_missing_variables": [
      "<string>"
    ],
    "campaign_missing_variables": [
      "<string>"
    ],
    "customers_missing_variables": [
      {
        "id": "<string>",
        "missing_variables": [
          "<string>"
        ]
      }
    ],
    "unknown_variables": [
      "<string>"
    ]
  }
}

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 campaign

Response

200 - application/json

The sendability of the campaign

​
sendable
boolean
required

Whether the campaign is sendable

​
errors
object

The errors if the campaign is not sendable. Only returned if sendable is false