Custom fields
| Tool | REST endpoint | Annotations |
|---|---|---|
list_custom_fields | GET /v1/custom-fields | read-only, idempotent |
create_custom_field | POST /v1/custom-fields | write |
update_custom_field | PATCH /v1/custom-fields/{fieldId} | write |
delete_custom_field | DELETE /v1/custom-fields/{fieldId} | destructive |
Valid types
text, textList, number, numberList, date, email, phone, imageUrl, imageUrlList, fileUrl, fileUrlList
list_custom_fields
No arguments. Returns the workspace's custom fields alongside the contact's default fields (name, email, birthdate, etc.).
create_custom_field
| Field | Type | Required | Description |
|---|---|---|---|
name | string (1-100) | yes | Visible name. |
type | enum (see above) | yes | Data type. |
description | string (≤ 500) | no | |
automatic | boolean | no | Whether it's computed automatically. Default false. |
overwritable | boolean | no | Whether an existing value can be overwritten. Default false. |
workspace | string | if multi-ws |
update_custom_field
Lets you edit description, automatic, and overwritable. The name and type cannot be edited. At least one of the three editable fields must be sent.
| Field | Required |
|---|---|
fieldId | yes |
workspace | if multi-ws |
description, automatic, overwritable | one of the three |
delete_custom_field
| Field | Required |
|---|---|
fieldId | yes |
workspace | if multi-ws |
Deletes the field and clears references on every client that had it assigned.