API Reference

Stop Campaign

post
https://api.joinpopp.com/v1/campaigns//stop

Stops a campaign and optionally sends a cancellation message to candidates

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

The ID of the campaign to stop

Body Params

Stop Campaign Request

Request to stop a campaign

boolean
Defaults to false

Whether to send a cancellation message to candidates

string
length between 1 and 1000

The cancellation message to send to candidates. Required when sendCancellationMessage is true.

string
length between 1 and 1000

Optional cancellation message sent to interviewer/availability-outreach conversations when a scheduling campaign stop cascades to its linked availability-outreach campaign. A system default is used if omitted.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?