Update campaign

curl --request PUT \
  --url https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "daily_limit_per_inbox": 50,
  "start_date": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "sending_days": [
    123
  ],
  "sending_window_start": 11,
  "sending_window_start_minute": 29,
  "sending_window_end": 12,
  "sending_window_end_minute": 29,
  "enable_tracking": true,
  "enable_unsubscribe": true,
  "ramp_up_enabled": true,
  "ramp_up_increment": 50,
  "ramp_up_max_limit": 500,
  "lead_mapping": {},
  "inbox_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "variants": [
    {
      "subject_template": "<string>",
      "email_content": "<string>",
      "variant_name": "A",
      "variant_label": "<string>",
      "distribution_percent": 100
    }
  ],
  "sequences": [
    {
      "step_number": 3,
      "trigger_type": "<string>",
      "wait_days": 15,
      "variants": [
        {
          "email_content": "<string>",
          "variant_name": "A",
          "variant_label": "<string>",
          "subject_template": "<string>",
          "distribution_percent": 100
        }
      ],
      "enable_unsubscribe": true
    }
  ],
  "launch": false
}
'

{
  "success": true,
  "message": "<string>",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "is_launch_ready": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "missing_requirements": [
    "<string>"
  ]
}

Campaigns

Update campaign

Update campaign configuration

Modify campaign settings, leads, inboxes, email content, or sequences. All validations are handled automatically - no need to track internal steps.

What Can Be Updated

Basic settings (name, schedule, limits)
Lead mapping configuration
Sender inbox selection
Email variants for A/B testing
Follow-up sequences

Launching a Campaign

Set launch: true when the campaign is ready to activate. The response includes is_launch_ready and missing_requirements to help you understand what’s needed.

Example Usage

import requests

campaign_id = "550e8400-e29b-41d4-a716-446655440000"

# Update campaign with email content
response = requests.put(
    f"https://api.coldsend.io/api/public/v1/campaigns/{campaign_id}",
    headers={"X-API-Key": "your-api-key"},
    json={
        "variants": [{
            "variant_name": "A",
            "subject_template": "Quick question, {{first_name}}",
            "email_content": "Hi {{first_name}},...",
            "distribution_percent": 100
        }]
    }
)

# Response shows what's still needed
# {"is_launch_ready": false, "missing_requirements": ["leads", "inboxes"]}

# Launch when ready
response = requests.put(
    f"https://api.coldsend.io/api/public/v1/campaigns/{campaign_id}",
    headers={"X-API-Key": "your-api-key"},
    json={"launch": true}
)
# {"status": "ACTIVE", "is_launch_ready": true, "missing_requirements": []}

PUT

api

public

campaigns

{campaign_id}

Update campaign

curl --request PUT \
  --url https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "daily_limit_per_inbox": 50,
  "start_date": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "sending_days": [
    123
  ],
  "sending_window_start": 11,
  "sending_window_start_minute": 29,
  "sending_window_end": 12,
  "sending_window_end_minute": 29,
  "enable_tracking": true,
  "enable_unsubscribe": true,
  "ramp_up_enabled": true,
  "ramp_up_increment": 50,
  "ramp_up_max_limit": 500,
  "lead_mapping": {},
  "inbox_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "variants": [
    {
      "subject_template": "<string>",
      "email_content": "<string>",
      "variant_name": "A",
      "variant_label": "<string>",
      "distribution_percent": 100
    }
  ],
  "sequences": [
    {
      "step_number": 3,
      "trigger_type": "<string>",
      "wait_days": 15,
      "variants": [
        {
          "email_content": "<string>",
          "variant_name": "A",
          "variant_label": "<string>",
          "subject_template": "<string>",
          "distribution_percent": 100
        }
      ],
      "enable_unsubscribe": true
    }
  ],
  "launch": false
}
'

{
  "success": true,
  "message": "<string>",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "is_launch_ready": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "missing_requirements": [
    "<string>"
  ]
}

Authorizations

X-API-Key

string

header

required

API key with format cs_live_xxx

Path Parameters

campaign_id

string<uuid>

required

Body

application/json

Request schema for updating a campaign via public API.

This schema does NOT expose internal step mechanics. Simply provide the fields you want to update, and the system will handle validation automatically. Set 'launch=true' when you're ready to activate the campaign.

name

string | null

Campaign name (minimum 8 characters)

Required string length: 8 - 255

daily_limit_per_inbox

integer | null

Maximum emails per inbox per day (1-100)

Required range: 1 <= x <= 100

start_date

string<date-time> | null

Campaign start date (ISO 8601 format)

timezone

string | null

Timezone for scheduling (IANA format)

Maximum string length: 100

sending_days

integer[] | null

Days to send (1=Monday, 7=Sunday)

Required array length: 1 - 7 elements

sending_window_start

integer | null

Sending window start hour (0-23)

Required range: 0 <= x <= 23

sending_window_start_minute

integer | null

Sending window start minute (0-59)

Required range: 0 <= x <= 59

sending_window_end

integer | null

Sending window end hour (1-24)

Required range: 1 <= x <= 24

sending_window_end_minute

integer | null

Sending window end minute (0-59). Must be 0 when sending_window_end is 24

Required range: 0 <= x <= 59

enable_tracking

boolean | null

Enable open tracking

enable_unsubscribe

boolean | null

Enable unsubscribe link

ramp_up_enabled

boolean | null

Enable or disable gradual ramp-up of daily sending volume per inbox. Setting to true resets ramp-up progress for all assigned inboxes.

ramp_up_increment

integer | null

Additional emails per inbox per day added on each ramp-up day (1-100)

Required range: 1 <= x <= 100

ramp_up_max_limit

integer | null

Maximum daily emails per inbox once fully ramped (1-1000)

Required range: 1 <= x <= 1000

lead_mapping

Lead Mapping · object

Column mapping from CSV to lead fields

inbox_ids

string<uuid>[] | null

Inbox IDs to use for sending

Minimum array length: 1

variants

PublicInlineVariantRequest · object[] | null

Email variants for A/B testing. All variants must sum to 100% distribution.

Show child attributes

sequences

PublicSequenceRequest · object[] | null

Follow-up email sequences (max 3)

Show child attributes

launch

boolean

default:false

Set to true when ready to activate the campaign. Campaign must have leads, inboxes, and email content.

Response

Campaign updated successfully

Response for public campaign update.

success

boolean

required

message

string

required

campaign_id

string<uuid>

required

Campaign ID

name

string

required

Campaign name

status

string

required

Campaign status: DRAFT, ACTIVE, PAUSED, COMPLETED, or FAILED

is_launch_ready

boolean

required

Whether the campaign has all required components to launch

updated_at

string<date-time>

required

Last update timestamp

missing_requirements

string[]

List of missing requirements before launch (empty if launch-ready)

Get campaign Delete campaign