Skip to content

Share Mailbox

POST
/mailboxes/{mailbox_id}/share

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.

Authorizations

Parameters

Path Parameters

mailbox_id
required

Mailbox id (mailboxes.id)

integer
>= 1

Mailbox id (mailboxes.id)

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Share a mailbox with the rest of the org, or stop sharing it.

object
shared_with_team
required

True makes the mailbox usable by every member of the org

boolean

Responses

200

Successful Response

object
data
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.

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