Update a smart field
update_smart_fieldChange an existing custom smart field's definition: its label, kind, required flag or integration binding. Only the fields you pass change, and the field keeps its id, so templates and campaign conditions that reference it still point to it. Use create_smart_field for a new field, delete_smart_field to remove one, and update_teammate to set a teammate's value (this tool never writes values directly). Binding a new integration or attribute queues a re-sync of the teammates' values from it (integrations never fill url fields); unlinking stops the sync. Overwrites the previous definition and returns the field. Needs the smart_fields:write scope; default fields are read-only (422), the computed Email field is not addressable (404), and a taken label, an invalid kind or an unknown integration returns 422.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The smart field's UUID (the `id` returned by list_smart_fields). | |
| kind | No | New field type. | |
| label | No | New display name. Must be unique in the workspace (422 `taken` otherwise). | |
| context | Yes | Explain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as "a user", "the customer", or "an account". Example: "Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution." | |
| required | No | Whether teammates must fill this field. | |
| integration_id | No | UUID of a workspace integration to sync values from (a directory or HR/enrichment integration from list_integrations). Pass null to unlink, which also clears integration_attribute. Omit to leave unchanged. | |
| integration_attribute | No | The integration's attribute key (required when the field is bound to an integration; 422 without it). Changing it re-syncs the field's values. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes |