Mailboxes

Set the signature

Replaces the mailbox's signature. Formatting, links, images and inline styles are kept; scripts, event handlers and javascript: links are stripped, and the stored result is returned. An empty string removes the signature. Refused with 403 when the domain enforces a signature template. Requires scope mail:write.

put/mailboxes/{address}/signature

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}/signature
  • Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

Request body

signatureHtmlstring required

HTML; "" removes the signature

Example request

{
  "signatureHtml": "<p>Alice Example<br><a href=\"https://acme.example\">acme.example</a></p>"
}

Response

Signature saved

successboolean

Example response

{
  "success": true,
  "data": {
    "saved": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.