/p2p_campaigns/:id/

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

Change the status (start / pause / stop) or rename a P2P (Peer-to-Peer) campaign.

PATCH semantics: send only the fields you want to change. Both status and name are optional; at least one must be provided.

Status values

ValueMeaningNotes
1START — run the campaignFails with 400 if no contacts, no caller ID, or pending approval
2PAUSE — pause a running campaignCampaign-list cache cleared on success
4END — stop the campaign permanentlyCache cleared; recurring child occurrences are also ended

Name editing while running

If the campaign is at status = 1 (START), name cannot be changed unless the same request also transitions out of START (status: 2 or status: 4). Otherwise returns 400 "Campaign must be stopped before it can be edited." — matches the rule the web UI enforces.

Path Params
string
required

Campaign ID

Body Params
number
enum
Defaults to 2

1 = START, 2 = PAUSE, 4 = END

Allowed:
string

Campaign name. Cannot be changed while status is 1 (START) unless the same request transitions out of START.

Responses

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