Skip to main content
PATCH
Update Domain Mailbox
The new user’s name is pushed to the mail provider.
Requires the Manage domains permission on the user of the API key. The target user must be a member of the team.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

mailboxId
string
required

The mailbox, from List Domain Mailboxes or Order Mailboxes

Body

application/json
assignToUserId
string
required

Team member who will send from the mailbox

Example:

"usr_Wf3Kp9Rd2Nz6Xc4Lj"

Response

Mailbox updated

ok
boolean
mailboxId
string
applied
string[]

Fields applied

assignedToUserId
string