Skip to content
/
Update Custom Field

Update Custom Field

Tool name: update-custom-field

Changes the name, description, group, labels, cardinality, subscription-email key, note or copy target of a custom field. Only what is passed is written; an empty string clears a text setting. The data type cannot be changed and is refused: an existing field keeps the type its stored values were written in. multiValue false collapses the field to ONE value per contact and DELETES the extra values contacts hold per subscription -- ask the person first, it cannot be undone and true is then refused for good. requestName is the key a contact writes as "key = value" in the body of a subscription email to fill this field; it addresses the field, so two fields sharing one means the first wins. copyToFieldId must name a field of a compatible type or the change is refused. Only fields the account created itself can be changed; the global ones are refused.

Input schema

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

ID of the field to change

namenull or string, <= 250 characters

New name of the field, which has to stay unique within the account; omit to keep the current one

Default:null
descriptionnull or string, <= 2000 characters

New description of what the field holds; omit to keep the current one

Default:null
categorynull or string, <= 250 characters

Group in the app; empty string sorts into none; omit to keep

Default:null
metaLabelsArray of strings or null, <= 50 items

New set of labels of the field, which replaces the current one; omit to keep the current labels

Default:null
multiValuenull or boolean

False collapses the field to one value per contact and DELETES the others; true is refused on a field that is already false; omit to keep

Default:null
requestNamenull or string, <= 250 characters

Key this field is addressed by in a subscription email body; empty string removes it; omit to keep

Default:null
notesnull or string, <= 1000 characters

Internal note on the field, which nobody outside the account sees; empty string removes it; omit to keep

Default:null
copyToFieldIdnull or string, <= 100 characters^[A-Za-z0-9_]*$

ID of the field every value written here is also copied into; empty string stops the copying; omit to keep

Default:null
accountIdnull or integer, >= 1

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

Default:null
Input example
{
  "customFieldId": "string",
  "name": null,
  "description": null,
  "category": null,
  "metaLabels": null,
  "multiValue": null,
  "requestName": null,
  "notes": null,
  "copyToFieldId": 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"
  ]
}