Search Tags

Tool name: search-tags

Lists the tags of a KlickTipp account with ID, name, type, whether they can be written and whether a contact can carry them more than once. Tags are either manual -- created and assigned deliberately -- or put on contacts by KlickTipp itself when something happens, for example a newsletter being sent, opened or clicked; the type says which. Can be narrowed by a text the name has to contain, by type, to the writable ones, by whether a contact can carry a tag once per subscription or only once overall, and to tags with a system role such as the test contact marker. The description of a tag is not part of the list -- use get-tag for that.

Input schema

querynull or string, <= 250 characters

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

Default:null

typenull or string

Only tags of this type, "tag" being the manual ones; omit for every type

Default:null

Enum:"apikey-subscribed""automation-finished""automation-started""businesscard-subscribed""campaign-clicked""campaign-converted""campaign-opened""campaign-sent""campaign-viewed""digistore-affiliation"

onlyWritablenull or boolean

Only manual tags the write tools may touch; omit to include the ones KlickTipp sets itself

Default:null

multiValuenull or boolean

true: tags a contact can carry once per subscription; false: once overall; omit for both

Default:null

systemRolenull or string

Only tags with this system role; "test-contact" marks contacts that receive test emails

Default:null

Value:"test-contact"

limitnull or integer, [ 1 .. 200 ]

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

Default:null

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null

Input example

{
  "query": null,
  "type": "apikey-subscribed",
  "onlyWritable": null,
  "multiValue": null,
  "systemRole": "test-contact",
  "limit": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

countintegerrequired

totalCountintegerrequired

hasMorebooleanrequired

tagsArray of objectsrequired

Output example

{
  "accountId": 0,
  "count": 0,
  "totalCount": 0,
  "hasMore": true,
  "tags": [
    {
      "id": 0,
      "name": "string",
      "type": "string",
      "isWritable": true,
      "isTestContactTag": true,
      "multiValue": true,
      "editUrl": "string"
    }
  ]
}