Skip to the page

Praecise Platform

Rivier/ Reference/ inbox

Inbox mailbox configure

put/workspace/inbox/mailbox-settings

Change a mailbox's sending switch, daily ceiling or undo window (owner or manager; turning sending on for a linked mailbox is the owner's).

Before you call

Credential: Authorization: Bearer $KEY
Scope: inbox:write
Graphql: Mutation.inboxMailboxConfigure
Sdk: inbox.mailbox.configure
Cli: inbox mailbox configure

Request bodyapplication/json, required

addressstringrequired
At most 254 characters.
sendEnabledboolean
dailyCapinteger or null
undoSecondsinteger or null

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/mailbox-settings' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "address": "string"
}'

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

This page as Markdown