POST
/
campaign_templates
/
{id}
curl --request POST \
  --url https://api.pocketflows.com/campaign_templates/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "campaign_name": "<string>"
}'
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "campaign": {
    "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
    }
  },
  "enabled": true
}

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 template

Body

application/json

Response

200 - application/json

The updated CampaignTemplate

The response is of type object.