Skip to main content
PUT
Update mailbox

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string<uuid>
required

Mailbox identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

firstName
string

Sender first name shown in the From header.

Required string length: 1 - 64
lastName
string

Sender last name shown in the From header.

Required string length: 1 - 64
signature
string | null

HTML signature stored on the mailbox. Null clears it. Not yet appended to outgoing messages.

Maximum string length: 10000
folderUuid
string<uuid> | null

Folder to move the mailbox into. Null means the root.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Successful response

mailbox
Mailbox · object
required

Updated mailbox.