Skip to main content
PUT
/
api
/
public
/
v1
/
campaigns
/
{campaign_id}
Update campaign
curl --request PUT \
  --url https://api.coldsend.io/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_end": 12,
  "enable_tracking": true,
  "enable_unsubscribe": true,
  "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
    }
  ],
  "current_step": 3
}
'
{
  "success": true,
  "message": "<string>",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_step": 123,
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "inbox_validations": [
    {
      "inbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_valid": true
    }
  ]
}

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

campaign_id
string<uuid>
required

Query Parameters

Body

application/json

Request schema for updating campaign in steps 2-5.

name
string | null
Required string length: 8 - 255
daily_limit_per_inbox
integer | null
Required range: 1 <= x <= 100
start_date
string<date-time> | null
timezone
string | null
Maximum string length: 100
sending_days
integer[] | null
Required array length: 1 - 7 elements
sending_window_start
integer | null
Required range: 0 <= x <= 23
sending_window_end
integer | null
Required range: 1 <= x <= 24
enable_tracking
boolean | null
enable_unsubscribe
boolean | null
lead_mapping
Lead Mapping · object

Column mapping from CSV to lead fields

inbox_ids
string<uuid>[] | null

List of inbox IDs to use for this campaign

Minimum array length: 1
variants
InlineVariantRequest · object[] | null

Email variants for A/B testing the initial email. At least one variant required.

sequences
SequenceRequest · object[] | null

Follow-up email sequences with their own variants

current_step
integer | null
Required range: 1 <= x <= 5

Response

Campaign updated successfully

Response for campaign update operations.

success
boolean
required
message
string
required
campaign_id
string<uuid>
required

Updated campaign ID

current_step
integer
required

Current campaign creation step

status
string
required

Campaign status

updated_at
string<date-time>
required

Last update timestamp

inbox_validations
InboxValidationResult · object[] | null

Inbox validation results (only included when updating inbox_ids)