Create a smart field
create_smart_fieldDefine a new custom smart field, a merge field signature templates and campaign conditions can use. Check list_smart_fields first: labels are unique, and to rename, retype or rebind an existing field use update_smart_field instead. A manual field starts empty; set each teammate's value with update_teammate. Bound to an integration (integration_id + integration_attribute), its values come from that integration and update_teammate can no longer set them; integrations do not fill url fields, so keep a url field manual. Creating the field changes no signature until a template references it. Writes one field and returns it. Needs the smart_fields:write scope; a taken label, an invalid kind or an unknown or unsuitable integration returns 422.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Field type (default text). url/email values are validated; image values are read-only via the API. | |
| label | Yes | Display name for the field (required). Must be unique in the workspace: a label already in use returns 422 `taken`. | |
| 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 (default true when omitted). | |
| integration_id | No | UUID of a workspace integration to sync this field's values from, from list_integrations. It must be a directory or HR/enrichment integration that supplies teammate data; any other returns 422. Omit for a manual field. | |
| integration_attribute | No | The integration's attribute key to map (required when integration_id is set; 422 without it). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes |