mailbox-sync-opt-out-controller
mailbox-sync-opt-out-controller endpoints of the bizSupply API.
GET /api/v1/sources/opt-out
Check whether your own mailbox is being synced
Returns the caller's own org-sync mailbox rows, including whether they have objected. Empty when their mailbox is not in the sync set.
Responses
| Status | Description |
|---|---|
200 | The caller's own mailbox rows |
POST /api/v1/sources/opt-out
Stop your mailbox being synced
Records an objection to your own mailbox being synced and stops it. The mailbox stays listed for your admin as opted out, so it cannot be silently re-added, and it is not resumed by anything short of you withdrawing this.
Responses
| Status | Description |
|---|---|
200 | The objection was recorded |
DELETE /api/v1/sources/opt-out
Allow your mailbox to be synced again
Withdraws a previous objection. Syncing resumes from where it stopped rather than re-reading your whole mailbox.
Responses
| Status | Description |
|---|---|
200 | The objection was withdrawn |