Skip to content

Create Custom Field

Tool name: create-custom-field

Creates a custom field definition in KlickTipp and returns its ID and the placeholder that renders it in newsletter content. Creating a field stores no value and changes no contact. Fields are never created as a side effect elsewhere, so a field a contact should have a value in has to be created here first. The data type is picked once and for good: it cannot be changed afterwards, so pick the one that matches what will be stored -- a date field for a date, a number field for an amount. multiValue decides whether a contact holds one value PER SUBSCRIPTION (true, the default when omitted) or one value overall (false); it is worth deciding here, because an existing field can only go from true to false and never back. The name has to be unique within the account. The description is what tells a later reader what belongs in the field.

Input schema

namestring, [ 1 .. 250 ] charactersrequired

Name of the field, which has to be unique within the account

typestringrequired

Data type of the field, which decides what can be stored in it and cannot be changed afterwards

Enum:"field-single""field-paragraph""field-email""field-number""field-url""field-date""field-time""field-datetime""field-html""field-decimal"
descriptionnull or string, <= 2000 characters

What the field holds, so a person or a model reading it later knows what to write into it

Default:null
multiValuenull or boolean

True: one value per subscription; false: one value overall; omit for true

Default:null
accountIdnull or integer, >= 1

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

Default:null
Input example
{ "name": "string", "type": "field-single", "description": null, "multiValue": null, "accountId": null }

Output schema

accountIdintegerrequired
idstringrequired
namestringrequired
typestringrequired
multiValuebooleanrequired
placeholderstringrequired
apiFieldIdstringrequired
categorystringrequired
descriptionstringrequired
metaLabelsArray of stringsrequired
editUrlstringrequired
usedByArray of stringsrequired
Output example
{ "accountId": 0, "id": "string", "name": "string", "type": "string", "multiValue": true, "placeholder": "string", "apiFieldId": "string", "category": "string", "description": "string", "metaLabels": [ "string" ], "editUrl": "string", "usedBy": [ "string" ] }