Mailboxes

Share Mailbox

Let the rest of the org send from this mailbox, or stop letting them.

Sharing hands over a sending CREDENTIAL, not a view: anyone in the org can then attach it to their own sequences. Explicit rather than a toggle, so a retried request cannot silently flip it back.

Owner-only (plus org admins and owners) - sharing is the one mailbox mutation a team-mate the mailbox is already shared with cannot perform. Needs a personal API key.

post/mailboxes/{mailbox_id}/share

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes/{mailbox_id}/share
  • Auth: HTTP bearer

Path parameters

mailbox_idinteger required

Mailbox id (mailboxes.id)

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

shared_with_teamboolean required

True makes the mailbox usable by every member of the org

Response

Successful Response

dataMailboxDomainPayload required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as "nothing to report" rather than "we did not tell you". Every value passes through scrub_vendor_names on the way in.

Changes

No recorded changes to this operation across all 2 revisions of this API.