Skip to content

Revalidate Inbox Mailbox

POST
/inbox/mailboxes/{mailbox}/revalidate

Re-check this mailbox’s credentials and folders, and store the answer.

Contacts no recipient. It connects to the provider to find out whether the stored credentials still work, then writes is_supported, the error message and the credential-error flag back onto the sync record - which is what makes a mailbox that silently stopped working visible.

Authorizations

Parameters

Path Parameters

mailbox
required

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

string

The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string