---
title: "Set the signature"
method: PUT
path: "/mailboxes/{address}/signature"
tags: ["Mailboxes"]
---

# Set the signature

`PUT /mailboxes/{address}/signature`

## Request

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

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`.

## Path parameters

- `address` string, required

## Request body

- SignatureUpdate
  - `signatureHtml` string, required: HTML; "" removes the signature

## Response `200`

Signature saved

- object
  - `success` boolean
  - `data` object
    - `saved` boolean
    - `signatureHtml` string: The signature as stored, after sanitising

## Other responses

- `401`: Missing or invalid API key
- `402`: The account's plan does not include the API (`plan_required`)
- `403`: The key lacks the required scope, or the domain enforces a signature template
- `404`: Resource not found
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/faivelo/apis/faivelo-api.md) · [All operations](https://skmtc.dev/faivelo/apis/faivelo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faivelo/apis/faivelo-api/revisions/a7413ddea5d1?raw)