PATCH /campaigns/{id}

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Path parameters

id string required

UUID of the campaign which you want to patch

Example: 550e8400-e29b-41d4-a716-446655440000

Body

application/json
name string

Campaign name.

Example: Warmup January Campaign
prioritize_new_leads boolean

If enabled — system prioritizes sending to new leads first.

Example: true
open_tracking boolean

Enable or disable email open tracking.

Example: true
stop_on_reply boolean

If true — campaign stops automatically when any lead replies.

Example: false
schedule object

Embedded schedule update object.

Show child attributes Hide child attributes
schedule.timezone string

Timezone key. Must match one of following keys.

Allowed values: Pacific/Midway, Pacific/Honolulu, America/Juneau, America/Boise, America/Dawson, America/Chihuahua, America/Phoenix, America/Chicago, America/Regina, America/Mexico_City, America/Belize, America/Detroit, America/Bogota, America/Caracas, America/Santiago, America/St_Johns, America/Sao_Paulo, America/Tijuana, America/Montevideo, America/Argentina/Buenos_Aires, America/Godthab, America/Los_Angeles, Atlantic/Azores, Atlantic/Cape_Verde, Etc/GMT, Europe/London, Europe/Dublin, Europe/Lisbon, Africa/Casablanca, Atlantic/Canary, Europe/Belgrade, Europe/Sarajevo, Europe/Brussels, Europe/Amsterdam, Africa/Algiers, Europe/Bucharest, Africa/Cairo, Europe/Helsinki, Europe/Athens, Asia/Jerusalem, Africa/Harare, Europe/Moscow, Asia/Kuwait, Africa/Nairobi, Asia/Baghdad, Asia/Tehran, Asia/Dubai, Asia/Baku, Asia/Kabul, Asia/Yekaterinburg, Asia/Karachi, Asia/Kolkata, Asia/Kathmandu, Asia/Dhaka, Asia/Colombo, Asia/Almaty, Asia/Rangoon, Asia/Bangkok, Asia/Krasnoyarsk, Asia/Shanghai, Asia/Kuala_Lumpur, Asia/Taipei, Australia/Perth, Asia/Irkutsk, Asia/Seoul, Asia/Tokyo, Asia/Yakutsk, Australia/Darwin, Australia/Adelaide, Australia/Sydney, Australia/Brisbane, Australia/Hobart, Asia/Vladivostok, Pacific/Guam, Asia/Magadan, Asia/Kamchatka, Pacific/Fiji, Pacific/Auckland, Pacific/Tongatapu

Example: Europe/Berlin
schedule.active_days number[]

Active days of week (1 = Monday ... 7 = Sunday)

Example: [1, 2, 3, 4, 5]
schedule.start_time string

Daily start time for sending emails. 30-minute increments.

Allowed values: 00:00, 00:30, 01:00, 01:30, 02:00, 02:30, 03:00, 03:30, 04:00, 04:30, 05:00, 05:30, 06:00, 06:30, 07:00, 07:30, 08:00, 08:30, 09:00, 09:30, 10:00, 10:30, 11:00, 11:30, 12:00, 12:30, 13:00, 13:30, 14:00, 14:30, 15:00, 15:30, 16:00, 16:30, 17:00, 17:30, 18:00, 18:30, 19:00, 19:30, 20:00, 20:30, 21:00, 21:30, 22:00, 22:30, 23:00, 23:30

Example: 09:00
schedule.end_time string

Daily end time for sending emails. 30-minute increments.

Allowed values: 00:00, 00:30, 01:00, 01:30, 02:00, 02:30, 03:00, 03:30, 04:00, 04:30, 05:00, 05:30, 06:00, 06:30, 07:00, 07:30, 08:00, 08:30, 09:00, 09:30, 10:00, 10:30, 11:00, 11:30, 12:00, 12:30, 13:00, 13:30, 14:00, 14:30, 15:00, 15:30, 16:00, 16:30, 17:00, 17:30, 18:00, 18:30, 19:00, 19:30, 20:00, 20:30, 21:00, 21:30, 22:00, 22:30, 23:00, 23:30

Example: 17:30
schedule.pause_between_emails_start number

Min pause between emails in seconds.

Example: 30
schedule.pause_between_emails_end number

Max pause between emails in seconds.

Example: 120
account_ids number[]

Array of account IDs (email senders) that campaign should use.

Example: [10, 14, 22]

Response

application/json

Campaign successfully updated

status string required

Status of action

Example: success