Update Email Signature

Tool name: update-signature

Updates an email signature's name, internal note, labels or digital business card; omitted fields stay and empty business-card strings clear them. Content, tag IDs and sender profile are never changed.

Input schema

signatureIdinteger, >= 1required

ID of the signature to update

namenull or string, [ 1 .. 250 ] characters

New unique name; omit to keep it, and note that the default signature cannot be renamed

Default:null

notesnull or string, <= 1000 characters

New internal note; omit to keep it, or pass an empty string to clear it

Default:null

metaLabelsArray of strings or null, <= 50 items

Replacement labels; omit to keep them, or pass an empty array to clear them

Default:null

vCardobject

Plain-text digital-business-card fields to change; omitted fields stay unchanged and empty strings clear fields

Default:null

accountIdnull or integer, >= 1

User ID of the account that owns the signature; omit for the token account, or pass an accessible subaccount ID

Default:null

Input example

{
  "signatureId": 1,
  "name": null,
  "notes": null,
  "metaLabels": null,
  "vCard": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

signatureIdintegerrequired

namestringrequired

isDefaultbooleanrequired

notesstringrequired

metaLabelsArray of stringsrequired

tagIdsArray of integersrequired

isUsablebooleanrequired

blockersArray of stringsrequired

senderProfileobjectrequired

vCardobjectrequired

contentobjectrequired

editUrlstringrequired

Output example

{
  "accountId": 0,
  "signatureId": 0,
  "name": "string",
  "isDefault": true,
  "notes": "string",
  "metaLabels": [
    "string"
  ],
  "tagIds": [
    0
  ],
  "isUsable": true,
  "blockers": [
    "string"
  ],
  "senderProfile": {
    "senderName": "string",
    "senderEmail": "string",
    "replyToEmail": "string",
    "ccEmail": "string",
    "bccEmail": "string",
    "toEmail": "string",
    "senderDomain": "string",
    "senderAddressStatus": "",
    "senderAddressIsUsable": true,
    "senderAddressExplanation": "string",
    "senderIdentity": {
      "effectiveSenderEmail": "string",
      "customerDomain": "string",
      "normalizedSenderDomain": "string",
      "status": "ready",
      "isUsable": true,
      "senderEmailOptions": [
        "string"
      ],
      "senderDomainOptions": [
        "string"
      ]
    }
  },
  "vCard": {
    "hasData": true,
    "firstName": "string",
    "lastName": "string",
    "companyName": "string",
    "emailAddress": "string",
    "phone": "string",
    "cellPhone": "string",
    "street": "string",
    "zip": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "website": "string"
  },
  "content": {
    "hasHtml": true,
    "hasPlain": true,
    "hasTransactionalHtml": true,
    "useInTransactionalEmails": true,
    "html": "string",
    "plain": "string",
    "transactionalHtml": "string"
  },
  "editUrl": "string"
}