Update a mailbox
Owner or admin only. Pause or resume sending, and change the daily cap, warm-up ramp, send window, timezone, or signature.
Owner or admin only. Pause or resume sending, and change the daily cap, warm-up ramp, send window, timezone, or signature.
Authorization
bearerAuth A Supabase Auth user access token for the signed-in SignalDock user, sent as Authorization: Bearer <token>. Paste one from a signed-in session, or obtain one through the oauth2 scheme; the API accepts either.
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://example.com/mailboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035", "provider": "gmail", "email": "string", "display_name": "string", "status": "connected", "daily_cap": 0, "ramp_start": 0, "ramp_step": 0, "send_window_start": 0, "send_window_end": 0, "timezone": "string", "signature": "string", "health": { "domain": "string", "spf": { "status": "pass", "record": "string", "detail": "string" }, "dkim": { "status": "pass", "record": "string", "detail": "string" }, "dmarc": { "status": "pass", "record": "string", "detail": "string" }, "mx": { "status": "pass", "record": "string", "detail": "string" }, "score": 0, "sendable": true }, "health_checked_at": "2019-08-24T14:15:22Z", "connected_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "sent_today": 0, "effective_cap": 0}Start connecting a mailbox POST
Owner or admin only. Returns the Google or Microsoft consent URL. After consent the browser returns to `returnTo` with `mailbox=connected` or `mailbox=error`.
Disconnect a mailbox DELETE
Owner or admin only. Deletes the mailbox and its stored token. Sent message history is kept.