Skip to the page

Praecise Platform

Rivier/ Reference/ campaigns

Pause, resume or cancel

post/crm/campaigns/{id}/control

Before you call

Credential: Authorization: Bearer $KEY
Scope: campaigns:write
Graphql: Mutation.campaignsCampaignControl
Sdk: campaigns.campaign.control
Cli: campaigns campaign control

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

actionstringrequired
One of: pause, resume, cancel.
reasonstring
At most 300 characters.

Responses

200application/json
Success
object
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/crm/campaigns/{id}/control' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "action": "pause"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown