Create Custom Field

Tool name: create-custom-field

Creates a custom-field definition and returns its ID and email placeholder. The type cannot change later. multiValue defaults to one value per subscription; changing to one value per contact later deletes extra values and cannot be reversed. Stores no contact values.

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"
  ]
}