WoyraDocs
Get an API key

The token's mailbox profile

GET/v1/mail/profile

Mailboxes · Requires an API key

Who the mailbox is to the people it writes to: the display name shown instead of the address, a picture (as a signed link good for a day), and on the Business and Professional plans the letterhead and signature carried on everything sent. canBrand says whether the plan includes them.

Example

curl https://api.woyra.io/v1/mail/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
401authentication_required, invalid_api_key

Also in Mailboxes