Get Custom Field

Tool name: get-custom-field

Returns one custom field definition of a KlickTipp account: its name and data type, the placeholder that renders the value of the receiving contact in newsletter content, the key the public API addresses it with, what the account wrote about what the field holds, its internal note, group and labels, the field its values are copied to, and whether a contact can hold more than one value in it. This returns the definition -- what a contact has stored in the field is read through the contact tools.

Input schema

customFieldIdstring, [ 1 .. 100 ] characters^[A-Za-z0-9_]+$required

Field ID: a number for the account's own field, a name such as "FirstName" for a global one

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "customFieldId": "string",
  "accountId": null
}

Output schema

accountIdintegerrequired

idstringrequired

namestringrequired

typestringrequired

isGlobalbooleanrequired

multiValuebooleanrequired

placeholderstringrequired

apiFieldIdstringrequired

categorystringrequired

descriptionstringrequired

notesstringrequired

metaLabelsArray of stringsrequired

copyToFieldIdstringrequired

requestNamestringrequired

editUrlstringrequired

Output example

{
  "accountId": 0,
  "id": "string",
  "name": "string",
  "type": "string",
  "isGlobal": true,
  "multiValue": true,
  "placeholder": "string",
  "apiFieldId": "string",
  "category": "string",
  "description": "string",
  "notes": "string",
  "metaLabels": [
    "string"
  ],
  "copyToFieldId": "string",
  "requestName": "string",
  "editUrl": "string"
}