ResellerHQ
Log inTry the sandbox free
GuidesAPI reference
Mailboxes

Reveal sign-in details

POST
/v1/mailboxes/{id}/credentials

The mailbox's password, app password and two-step verification secret, with the Gmail IMAP and SMTP settings. Each reveal is recorded in your activity log. Two ways to connect: sign in through OAuth with a client ID granted on the domain, or use the app password over IMAP/SMTP.

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

Response Body

Success

application/json
  1. response

Success

email*string
password*string
appPassword*string

For IMAP and SMTP, in place of the password

totpSecret*string

The base32 seed of its two-step verification

imap*
smtp*
curl -X POST "https://example.com/v1/mailboxes/mbx_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/credentials"
{  "email": "[email protected]",  "password": "string",  "appPassword": "string",  "totpSecret": "string",  "imap": {    "host": "imap.gmail.com",    "port": 993,    "security": "ssl"  },  "smtp": {    "host": "smtp.gmail.com",    "port": 587,    "security": "starttls"  }}

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`.

Get a sign-in code POST

The mailbox's current two-step verification code.