admin toolset
save_custom_field
Create or update a custom field. Creates a custom field (no id: entity, key, label and type required) or updates one (id). Entity, key and type are fixed once created. select/multiselect need options. For post fields, on_public_form lets customers see and fill the field (not member fields); add it to a board's form with save_board form_fields (at most 5), and required makes customers fill it there. Nobody is emailed. Managers and owners.
- Toolset
- admin
- Who can call it
- OwnersManagersAPI keys
- REST
POST /api/v1/w/{workspace}/custom-fields- Behavior
- changes dataidempotentaccepts idempotency_key
Input
| Field | Type | Description |
|---|---|---|
id | string | The field's ID, to update it. |
entity | one of: post, user, company | What the field describes: post, user or company. |
key | string | snake_case key, fixed once created. Filter with custom.<key> (posts). |
label | string | |
type | one of: text, multiline, number, date, select, multiselect, checkbox, url, member | text, multiline, number, date (YYYY-MM-DD), select (one option), multiselect (several), checkbox (true/false), url, or member (a team member's ID). |
options | array of string | Choices for select and multiselect (at most 50). |
on_public_form | boolean | |
required | boolean | |
position | integer | |
expected_version | integer | The field's version from your last read; the call fails if it changed since. |
idempotency_key | string | Retry-safe key. Repeating a call with the same key returns the first result. |
Output
| Field | Type | Description |
|---|---|---|
fieldrequired | object | |
createdrequired | boolean | |
admin_urlrequired | string (uri) |
Calling it
// MCP: tools/call
{ "name": "save_custom_field", "arguments": {} }
// Typed client
await carechannel.save_custom_field({});