Skip to the page

Praecise Platform

Rivier/ Reference/ inbox

Read new mail from the project's mailboxes into the inbox

post/workspace/inbox/sync

Read new mail from the project's mailboxes into the inbox. Read only: nothing is marked, moved or deleted at the source.

Before you call

Credential: Authorization: Bearer $KEY
Scope: inbox:write
Graphql: Mutation.inboxMailboxSync
Sdk: inbox.mailbox.sync
Cli: inbox mailbox sync

Request bodyapplication/json, required

mailboxstring
At most 254 characters.
limitinteger
At least 1. At most 200.

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

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

This page as Markdown