Update ICP

Updates an ICP. This is also how you pause and resume sending: set doSendEmails to false to pause, true to resume.

scheduledStartAt and doSendEmails are mutually exclusive: setting a future scheduledStartAt forces doSendEmails to false, and setting doSendEmails: true clears any schedule. Pass scheduledStartAt: null to cancel a schedule without starting the ICP.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Get this from Settings > Workspaces. Starts with "account_".

string
required

Get this from Settings > Workspaces > Workspace ID column. On read endpoints you may also pass the literal value all to span every workspace in the account.

string
required

ICP id. Get it from List ICPs or the ICPs page in the dashboard.

Body Params
string
string
string
companySize
array of strings
length ≥ 1
companySize
string
string
string
string
string
boolean

false pauses the ICP, true resumes it.

date-time | null

Future instant at which the ICP starts sending on its own. Must be in the future. null cancels an existing schedule.

integer
1 to 10
integer | null

Cap on first-touch emails per day. null means unlimited.

boolean
boolean

Stop emailing a company once anyone there replies.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json