Skip to Content
SendlySendly
API ReferenceMailboxes

Set a mailbox's signature

PUT
/api/mailboxes/{id}/signature

Set, change or remove the mailbox's email signature, and choose whether it belongs on new messages and on replies. Send any of the three keys; a key left out is unchanged. text: null removes the signature.

The signature is plain text. At most 1000 characters and 12 lines; control characters and trailing whitespace are removed before it is stored, and the response shows the stored form. There is no html field, and unknown keys are refused: the mailbox render path accepts no caller markup and builds no link out of text.

Saving a signature changes no message by itself. A send through sendMailboxMessage or replyToMailboxConversation carries it only when that request sets includeSignature: true. The dashboard composer reads includeOnNewMessages / includeOnReplies and puts the signature in the draft, where the sender can edit or delete it before sending.

The current value is read on getMailbox (signature). Sendly's copy is the one it sends with; the text is also stored on the mailbox's JMAP Identity (textSignature / htmlSignature) so a JMAP mail client offers the same signature. IMAP has no signature setting, so an IMAP client keeps its own.

Any member of the project may call this, and so may an API key holding mailboxes:write.

Requires the mailboxes:write scope — Create and delete mailboxes on your verified domains.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string
Formatuuid
application/json
  1. body

Body for PUT /api/mailboxes/{id}/signature. Send any of the three keys; a key left out is unchanged. text is plain text (at most 1000 characters and 12 lines), stored after control characters and trailing whitespace are removed; null or an empty string removes the signature.

text?|
Lengthlength <= 1000
includeOnNewMessages?boolean
includeOnReplies?boolean

Response Body

The signature as stored

application/json
  1. response
success*true
Value intrue
data*

A mailbox's email signature. Plain text only: nothing in it is rendered as markup, and a URL is linkified by the recipient's mail client like any other. It is added to a message sent through the API only when that send sets includeSignature: true; the two switches describe the dashboard composer, which puts the signature in the draft for the sender to see, edit or remove.

Example Request
curl -X PUT 'https://api.sendly.now/api/mailboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08/signature' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "data": {    "text": "string",    "includeOnNewMessages": true,    "includeOnReplies": true  }}