Skip to content

Create Email Signature

Tool name: create-signature

Creates or copies an email signature. Name and tag IDs replace source values; supplied content, sender and business-card fields override copied values, while omitted copied fields stay. HTML needs %Link:Unsubscribe% as the href of a link plus %User:FirstName%, %User:LastName%, %User:Street%, %User:Zip%, %User:City% and %User:Country%; allowed address omissions are exempt. Plain needs the same, but unsubscribe may be text; it is stored only when plain-content editing is allowed, otherwise regenerated from HTML. Transactional HTML needs the address placeholders and no %Link:Unsubscribe%; %Link:SubscriberInfo% is recommended. Tags, addresses and domains must exist; the sender address must have a verified domain, and an omitted sender domain is derived and stored. Returns content flags only; use get-signature with includeContent true. No newsletter changes.

Input schema

namestring, [ 1 .. 250 ] charactersrequired

Unique name of the new signature

tagIdsArray of integers, <= 50 itemsrequired

At least one existing tag ID for the new signature; every tag must be unassigned to another signature

sourceSignatureIdnull or integer, >= 1

Existing signature of the same account to copy; omit when supplying content for a new signature

Default:null
contentobject

Complete HTML, plain and transactional content block; required without a source and replaces copied content when supplied

Default:null
senderProfileobject

Optional sender, reply, CC, BCC, recipient and sender-domain fields; omitted copied fields are preserved, and the sender domain is derived from the resulting sender address when omitted

Default:null
vCardobject

Optional plain-text digital-business-card fields; supplied fields override copied values, omitted copied fields stay, and empty strings clear fields

Default:null
notesnull or string, <= 1000 characters

Internal note; on a copy, omit to preserve the source note

Default:null
metaLabelsArray of strings or null, <= 50 items

Labels; on a copy, omit to preserve the source labels

Default:null
accountIdnull or integer, >= 1

User ID of the account in which to create the signature; omit for the token account, or pass an accessible subaccount ID

Default:null
Input example
{ "name": "string", "tagIds": [ 1 ], "sourceSignatureId": null, "content": null, "senderProfile": null, "vCard": null, "notes": null, "metaLabels": null, "accountId": null }