Inbox delivery report

post/workspace/inbox/delivery-events

Report what happened to sent messages (delivered, temporary or permanent bounce, complaint); permanent bounces and complaints put the address on the do-not-send list (owner or manager, or the project's key).

Before you call

Credential: Authorization: Bearer $KEY
Scope: inbox:write
Graphql: Mutation.inboxDeliveryReport
Sdk: inbox.delivery.report
Cli: inbox delivery report

Request bodyapplication/json, required

eventslist of objectrequired
- kindstringrequired
  One of: delivered, soft_bounce, hard_bounce, complaint.
- addressstringrequired
  At most 254 characters.
- providerIdstring
  At most 300 characters.
- messageIdstring
  At most 500 characters.
- detailstring
  At most 500 characters.

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/workspace/inbox/delivery-events' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "events": [
    {
      "kind": "delivered",
      "address": "string"
    }
  ]
}'

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

This page as Markdown