AuralisDocs
OperationsChannels and email

Re-check the connected mailbox with Google now

Ask Google what it currently allows and write the answer down.

/v1/channels/email/mailbox/refreshAdmin
Operation id
refresh_mailbox
Access
An editor or a viewer is refused.
POST/v1/channels/email/mailbox/refresh

Ask Google what it currently allows and write the answer down.

On demand as well as on the poller's timer, for the same reason the domain path has a verify route: the person who has just reconnected is sitting in front of the screen.

Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.

Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.

Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:write scope, and the workspace role of the person who owns it must meet the floor above.

Authorization

AuthorizationBearer <token>

A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/channels/email/mailbox/refresh"
{  "connected": true,  "email_address": "string",  "scopes": [    "string"  ],  "sendable": true,  "polling": true,  "inbound_cursor_set": true,  "connected_at": "string",  "healthy_at": "string",  "last_polled_at": "string",  "sent_today": 0,  "checks": [    {      "check": "authorisation",      "status": "not_started",      "detail": "string",      "remediation": "string",      "last_checked_at": "2019-08-24T14:15:22Z"    }  ]}