Skip to main content
PATCH
Update campaign

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string<uuid>
required

Campaign ID.

Body

application/json
name
string

Campaign name.

Required string length: 1 - 200
sequence_type
enum<string>

Who the campaign is for. Admins only for signed-in users.

Available options:
candidate,
business_development,
candidate_nurture,
client_nurture
enable_sequence_automation
boolean

Move people through the linked job pipeline as they reply. Admins only for signed-in users.

stop_on_response
boolean

Stop emailing a person once they reply. Always off for nurture campaigns.

send_on_weekends
boolean

Allow emails to go out on Saturdays and Sundays.

send_on_holidays
boolean

Allow emails to go out on public holidays. When off, the campaign skips the holidays in your workspace's holiday calendar.

Track link clicks.

open_tracking
boolean

Track email opens.

Add an unsubscribe link to every email.

is_archived
boolean

Archive or unarchive. Archiving stops everyone still in the campaign; unarchiving does not restart them.

Response

Campaign updated

success
enum<boolean>
required
Available options:
true
data
object
required