Skip to the page

Praecise Platform

Rivier/ Reference/ campaigns

Create or change an unsubscribe group

post/mail/groups

Create or change an unsubscribe group. The group is the consent purpose email., so the preference page and one-click unsubscribe already honour it.

Before you call

Credential: Authorization: Bearer $KEY
Scope: campaigns:write
Graphql: Mutation.campaignsMailGroupSave
Sdk: mail.groups.save
Cli: mail group-save

Request bodyapplication/json, required

idstringrequired
Lower-case letters, digits, dashes; the consent purpose is email. At most 40 characters.
namestringrequired
At most 80 characters.
descriptionstring
At most 300 characters.
kindstring
marketing needs the person's granted consent; service (receipts, security) does not, but honours a full unsubscribe One of: service, marketing.
isDefaultboolean

Responses

200application/json
Success
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/mail/groups' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "string",
  "name": "string"
}'

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

This page as Markdown