WoyraDocs
Get an API key

Set the picture at the head of the letterhead

PUT/v1/mail/profile/letterhead-image

Mailboxes · Requires an API key

The image bytes as the body, PNG or JPEG, at most 300 KB; the type is read from the bytes. A logo or banner, ideally 1200 pixels wide (it is laid out at up to 600). Sent mail carries the picture itself as an inline image, so recipients see it without loading remote content. Business and Professional plans only.

Example

curl -X PUT https://api.woyra.io/v1/mail/profile/letterhead-image \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 The profile, with the new picture's preview link.

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
400invalid_request, unsupported_version
401authentication_required, invalid_api_key

Also in Mailboxes