Change the project's mail API settings

put/mail/settings

Change the project's mail API settings. Choosing the own MTA does not switch it on: it is used for a domain only after the deliverability checks pass.

Before you call

Credential: Authorization: Bearer $KEY
Scope: campaigns:write
Graphql: Mutation.campaignsMailSettingsUpdate
Sdk: mail.settings.update
Cli: mail settings-update

Request bodyapplication/json, required

ratePerMinuteinteger or null
trackOpensboolean
trackClicksboolean
defaultGroupstring or null
transportstring
One of: auto, own-mta, resend, furcate-mail.
domainTransportobject
retentionDaysinteger
At least 1. At most 730.

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 PUT 'https://api.rivier.ai/mail/settings' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "ratePerMinute": 0,
  "trackOpens": false,
  "trackClicks": false,
  "defaultGroup": "string",
  "transport": "auto",
  "domainTransport": {},
  "retentionDays": 0
}'

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

This page as Markdown