Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Campaign

Patch campaign

Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all

patch/api/v2/campaigns/{id}

Path parameters

idstring uuid required
Example:019f94cd-ae29-7a22-ba1e-eadab74967a4

The ID of the item to update

Request body

namestring

Name of the campaign

pl_valuenumber nullable

Value of every positive lead

is_evergreenboolean nullable

Whether the campaign is evergreen

email_gapnumber nullable

The gap between emails in minutes

random_wait_maxnumber nullable

The maximum random wait time in minutes

text_onlyboolean nullable

Whether the campaign is text only

first_email_text_onlyboolean nullable

Whether the campaign is send the first email as a text only

email_liststring[]

List of accounts to use for sending emails

daily_limitnumber nullable

The daily limit for sending emails

stop_on_replyboolean nullable

Whether to stop the campaign on reply

email_tag_liststring[]

List of tags to use for sending emails

link_trackingboolean nullable

Whether to track links in emails

open_trackingboolean

Whether to track opens in emails

stop_on_auto_replyboolean nullable

Whether to stop the campaign on auto reply

daily_max_leadsinteger nullable

The daily maximum new leads to contact

prioritize_new_leadsboolean nullable

Whether to prioritize new leads

match_lead_espboolean nullable

Whether to match leads by ESP

stop_for_companyboolean nullable

Whether to stop the campaign for the entire company(domain) when a lead replies

insert_unsubscribe_headerboolean nullable

Whether to insert an unsubscribe header in emails

allow_risky_contactsboolean nullable

Whether to allow risky contacts

disable_bounce_protectboolean nullable

Whether to disable bounce protection

cc_liststring[]

List of accounts to CC on emails

bcc_liststring[]

List of accounts to BCC on emails

owned_bystring uuid nullable

Owner ID

Example request

{
  "name": "My First Campaign",
  "pl_value": 100,
  "campaign_schedule": {
    "start_date": "2025-09-25",
    "end_date": "2025-09-25",
    "schedules": [
      {
        "name": "My Schedule",
        "timing": {
          "from": "09:00",
          "to": "17:00"
        },
        "days": {
          "0": true,
          "1": true,
          "2": true,
          "3": true,
          "4": true
        },
        "timezone": "Etc/GMT+12"
      }
    ]
  },
  "sequences": [
    {
      "steps": [
        {
          "type": "email",
          "delay": 2,
          "delay_unit": "days",
          "pre_delay": 2,
          "pre_delay_unit": "days",
          "variants": [
            {
              "subject": "Hello {{firstName}}",
              "body": "Hey {{firstName}},\n\nI hope you are doing well.",
              "v_disabled": true
            }
          ]
        }
      ]
    }
  ],
  "email_gap": 10,
  "random_wait_max": 10,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "email_tag_list": [
    "019f94cd-8394-7231-81aa-6fdfe913cf6b"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "daily_max_leads": 100,
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "limit_emails_per_company_override": {
    "mode": "custom",
    "daily_limit": 3,
    "scope": "per_campaign"
  },
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "owned_by": "019f94cd-8394-7231-81aa-6fe19097c842",
  "provider_routing_rules": [
    {
      "action": "send",
      "recipient_esp": [
        "all"
      ],
      "sender_esp": [
        "all"
      ]
    }
  ]
}

Response

The updated Campaign

idstring uuid required

Unique identifier for the campaign

namestring required

Name of the campaign

pl_valuenumber nullable

Value of every positive lead

status-99 | -1 | -2 | 0 | 1 | 2 | 3 | 4 required

Campaign Status

is_evergreenboolean nullable

Whether the campaign is evergreen

timestamp_createdstring required

Timestamp when the campaign was created

timestamp_updatedstring required

Timestamp when the campaign was last updated

email_gapnumber nullable

The gap between emails in minutes

random_wait_maxnumber nullable

The maximum random wait time in minutes

text_onlyboolean nullable

Whether the campaign is text only

first_email_text_onlyboolean nullable

Whether the campaign is send the first email as a text only

email_liststring[]

List of accounts to use for sending emails

daily_limitnumber nullable

The daily limit for sending emails

stop_on_replyboolean nullable

Whether to stop the campaign on reply

email_tag_liststring[]

List of tags to use for sending emails

link_trackingboolean nullable

Whether to track links in emails

open_trackingboolean

Whether to track opens in emails

stop_on_auto_replyboolean nullable

Whether to stop the campaign on auto reply

daily_max_leadsinteger nullable

The daily maximum new leads to contact

prioritize_new_leadsboolean nullable

Whether to prioritize new leads

match_lead_espboolean nullable

Whether to match leads by ESP

not_sending_status1 | 2 | 3 | 4 | 99 nullable

Campaign not sending status

stop_for_companyboolean nullable

Whether to stop the campaign for the entire company(domain) when a lead replies

core_variablesobject nullable

Campaign core variables

custom_variablesobject nullable

Campaign custom variables

insert_unsubscribe_headerboolean nullable

Whether to insert an unsubscribe header in emails

allow_risky_contactsboolean nullable

Whether to allow risky contacts

disable_bounce_protectboolean nullable

Whether to disable bounce protection

cc_liststring[]

List of accounts to CC on emails

bcc_liststring[]

List of accounts to BCC on emails

organizationstring uuid nullable

Organization ID

owned_bystring uuid nullable

Owner ID

ai_sdr_idstring uuid nullable

AI Sales Agent ID that created this campaign

Example response

{
  "id": "019f94cd-8394-7231-81aa-6fdeda501906",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "campaign_schedule": {
    "start_date": "2025-09-25",
    "end_date": "2025-09-25",
    "schedules": [
      {
        "name": "My Schedule",
        "timing": {
          "from": "09:00",
          "to": "17:00"
        },
        "days": {
          "0": true,
          "1": true,
          "2": true,
          "3": true,
          "4": true
        },
        "timezone": "Etc/GMT+12"
      }
    ]
  },
  "sequences": [
    {
      "steps": [
        {
          "type": "email",
          "delay": 2,
          "delay_unit": "days",
          "pre_delay": 2,
          "pre_delay_unit": "days",
          "variants": [
            {
              "subject": "Hello {{firstName}}",
              "body": "Hey {{firstName}},\n\nI hope you are doing well.",
              "v_disabled": true
            }
          ]
        }
      ]
    }
  ],
  "timestamp_created": "2026-07-24T15:45:24.372Z",
  "timestamp_updated": "2026-07-24T15:45:24.372Z",
  "email_gap": 10,
  "random_wait_max": 10,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "email_tag_list": [
    "019f94cd-8394-7231-81aa-6fdfe913cf6b"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "daily_max_leads": 100,
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "not_sending_status": 2,
  "limit_emails_per_company_override": {
    "mode": "custom",
    "daily_limit": 3,
    "scope": "per_campaign"
  },
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "organization": "019f94cd-8394-7231-81aa-6fe028c6f404",
  "owned_by": "019f94cd-8394-7231-81aa-6fe19097c842",
  "ai_sdr_id": "019f94cd-8394-7231-81aa-6fe227c1bda3",
  "provider_routing_rules": [
    {
      "action": "send",
      "recipient_esp": [
        "all"
      ],
      "sender_esp": [
        "all"
      ]
    }
  ]
}