Search Email Signatures

Tool name: search-signatures

Searches email signatures by name with sender readiness, selection tags and business-card availability (required by add-email-editor-contact-card). Unusable signatures are excluded unless includeUnusable is true, which also returns blockers. Content is read by get-signature; to select signatures automatically by tags, pass signature ID 0 to configure-newsletter-delivery.

Input schema

querynull or string, <= 250 characters

Text the name of a signature has to contain; omit to list them all

Default:null

includeUnusablenull or boolean

True to also return signatures that cannot currently be used, with their blockers; omit to leave them out

Default:null

limitnull or integer, [ 1 .. 200 ]

How many signatures to return at most, 1 to 200, 50 by default

Default:null

accountIdnull or integer, >= 1

User ID of the account to list signatures for; omit for the token account, or pass an accessible subaccount ID

Default:null

Input example

{
  "query": null,
  "includeUnusable": null,
  "limit": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

countintegerrequired

totalCountintegerrequired

hasMorebooleanrequired

unusableCountintegerrequired

signaturesArray of objectsrequired

Output example

{
  "accountId": 0,
  "count": 0,
  "totalCount": 0,
  "hasMore": true,
  "unusableCount": 0,
  "signatures": [
    {
      "signatureId": 0,
      "name": "string",
      "isDefault": true,
      "senderName": "string",
      "senderEmail": "string",
      "effectiveSenderEmail": "string",
      "senderIdentityStatus": "ready",
      "senderAddressStatus": "",
      "tagIds": [
        0
      ],
      "isUsable": true,
      "blockers": [
        "string"
      ],
      "hasVCardData": true,
      "editUrl": "string"
    }
  ]
}