ResellerHQ
Log inTry the sandbox free
GuidesAPI reference
Mailboxes

Update a mailbox

PATCH
/v1/mailboxes/{id}

Changes the name, username (and so the address), profile picture or password of a set-up mailbox.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Path Parameters

id*string

Request Body

application/json
  1. body
firstName?string
Length1 <= length <= 60
lastName?string
Length1 <= length <= 60
username?string
Length1 <= length <= 64
profilePictureUrl?string
Formaturi
Lengthlength <= 2048
password?string
Length12 <= length <= 100

Response Body

Success

application/json
  1. response

Success

id*string
mailboxDomainId*string
email*string
username*string
firstName*string
lastName*string
profilePictureUrl*string|null
isAdmin*boolean

The domain's first mailbox, which administers its Google account. OAuth client IDs are granted through it

status*string

queued until the domain is connected; provisioning while it is being set up (minutes to a few hours); active with its sign-in details ready; failed if it could not be set up, when nothing is charged for it; cancelled once its domain is deleted

Value in"queued""provisioning""active""failed""cancelled"
setupStage*|

Where setup has got to while provisioning

failure*|

Why the mailbox is failed

customerId*string|null
activatedAt*|null
actor*|

Who did it; null for anything done before we recorded that

createdAt*string
Formatdate-time
curl -X PATCH "https://example.com/v1/mailboxes/mbx_01K6XJ4Q8ZT3M9R5V2B7WDHNCA" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "mbx_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "mailboxDomainId": "mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "email": "[email protected]",  "username": "jo",  "firstName": "Jo",  "lastName": "Bloggs",  "profilePictureUrl": "string",  "isAdmin": true,  "status": "queued",  "setupStage": "configuring_dns",  "failure": {    "code": "DOMAIN_IN_USE_GOOGLE",    "message": "Domain is already in use in Google Workspace."  },  "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "activatedAt": "2026-10-07T11:04:31.000Z",  "actor": {    "kind": "user",    "label": "string"  },  "createdAt": "2026-10-07T11:04:31.000Z"}

Get a mailbox GET

Previous Page

Upload a mailbox profile photo POST

Sets the Google profile photo of a set-up mailbox from an uploaded PNG, JPEG, WebP or GIF (at most 1 MB): the photo people see beside its mail. To use an image already online, send its address as `profilePictureUrl` to `PATCH /mailboxes/:id`.