Inbox message retention set

put/messages/retention

Set how many days the log keeps messages (1 to 3650), or null for the deployment default.

Before you call

Credential: Authorization: Bearer $KEY
Scope: inbox:write
Graphql: Mutation.inboxMessageRetentionSet
Sdk: inbox.messageRetention.set
Cli: inbox message retention set

Request bodyapplication/json, required

daysinteger or nullrequired

Responses

200application/json
Success
- daysnumber or nullrequired
- defaultDaysnumberrequired
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/messages/retention' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "days": 0
}'

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

This page as Markdown