Skip to the page

Praecise Platform

Rivier/ Reference/ campaigns

Send a test to one of the project's own addresses

post/crm/campaigns/{id}/test

Before you call

Credential: Authorization: Bearer $KEY
Scope: campaigns:write
Graphql: Mutation.campaignsCampaignTest
Sdk: campaigns.campaign.test
Cli: campaigns campaign test

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

tostring (email)required

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}/test' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "name@example.com"
}'

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

This page as Markdown