Skip to the page

Praecise Platform

Rivier/ Reference/ inbox

Allow or block a sender or domain, or clear the rule (owner or manager)

put/workspace/inbox/senders

Before you call

Credential: Authorization: Bearer $KEY
Scope: inbox:write
Graphql: Mutation.inboxSenderSet
Sdk: inbox.sender.set
Cli: inbox sender set

Request bodyapplication/json, required

patternstringrequired
At most 254 characters.
rulestring or nullrequired

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/workspace/inbox/senders' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "pattern": "string",
  "rule": "allow"
}'

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

This page as Markdown