Skip to main content
POST
/
campaign_templates
/
{id}
Update a campaign template
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>",
    "created_at": "<string>",
    "updated_at": "<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": "draft",
    "scheduled_at": "<string>",
    "statistics": {
      "total_customers_enrolled": 123,
      "total_customers_started": 123,
      "total_customers_finished": 123,
      "emails": {
        "sent": 123,
        "delivered": 123,
        "opened": 123,
        "soft_bounced": 123,
        "hard_bounced": 123,
        "clicked": 123
      },
      "custom_steps": [
        {
          "custom_step": "<string>",
          "sent": 123
        }
      ]
    },
    "consumed_message_segments": {
      "sms": 123,
      "mms": 123,
      "email": 123
    },
    "estimated_message_segments": {
      "sms": 123,
      "mms": 123,
      "email": 123
    },
    "attributed_revenue": 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
title
string

The title of the campaign template

description
string

The description of the campaign template

campaign_name
string

The name of the campaign that will be created when the campaign template is used as a base

Response

200 - application/json

The updated CampaignTemplate

id
string
required

The ID of the campaign template

title
string
required

The title of the campaign template

description
string
required

The description of the campaign template

campaign
object
required

The campaign that will get created when the campaign template is used as a base

enabled
boolean
required

Whether the campaign template is enabled

I