WoyraDocs
Get an API key

Change the display name, letterhead or signature

PATCH/v1/mail/profile

Mailboxes · Requires an API key

Fields left out are kept. A letterhead or signature on a plan without them is refused with 400; clearing one is always allowed. Each block has a plain-text and an HTML version; one missing is made from the other at send time.

Body

FieldTypeDescription
displayNamestring
letterheadMailBranding
signatureMailBranding
footerMailBranding

Example

curl -X PATCH https://api.woyra.io/v1/mail/profile \
  -H "Authorization: Bearer $WOYRA_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "<displayName>",
    "letterhead": "<letterhead>",
    "signature": "<signature>"
  }'

Response

200 The profile after the change.

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