WoyraDocs
Get an API key

A mailbox's profile

GET/v1/mailboxes/{id}/profile

Mailboxes · Requires an API key

The display name, picture link, letterhead and signature, as GET /v1/mail/profile returns them, for the account's own mailbox. Scope mailboxes:manage.

Parameters

NameInDescription
idrequiredpath

Example

curl https://api.woyra.io/v1/mailboxes/email_01J.../profile \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 The profile.

FieldTypeDescription
objectrequiredstring
One of mail_profile.
addressrequiredstring
displayNamerequiredstring
planrequiredstring
One of essential, business, professional.
canBrandrequiredbooleanWhether the plan includes a letterhead
pictureUrlstringA signed link to the picture
letterheadrequiredMailBranding
signaturerequiredMailBranding
footerMailBranding
letterheadImageUrlstringA signed link to the letterhead picture

Errors

StatusCodes
404not_found, product_not_offered

Also in Mailboxes