DELETE
/
campaigns
/
{id}
curl --request DELETE \
  --url https://api.pocketflows.com/campaigns/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "name": "<string>",
  "enrolled_customers": [
    "<string>"
  ],
  "segment": "<string>",
  "steps": [
    {
      "type": "email",
      "custom_step_id": "<string>",
      "email_template_id": "<string>"
    }
  ],
  "email_address": "<string>",
  "phone_number": "<string>",
  "status": "<string>",
  "scheduled_at": "<string>",
  "statistics": {
    "total_customers_enrolled": 123,
    "total_customers_started": 123,
    "total_customers_finished": 123
  },
  "consumed_message_segments": {
    "sms": 123,
    "mms": 123,
    "email": 123
  },
  "estimated_message_segments": {
    "sms": 123,
    "mms": 123,
    "email": 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 campaign

Response

200 - application/json

The deleted Campaign object

The response is of type object.