fields_create_deal_field
Create custom fields for deals to capture specific data like dropdowns, monetary values, or dates. Specify field name, type, and option labels for enum/set fields.
Instructions
Create a new custom field for deals.
For enum and set field types, you must provide options (a non-empty array of { label } objects).
Common use cases:
Add a "Deal Source" dropdown to deals
Add a custom monetary value (e.g., "Expected Upsell")
Add a date field (e.g., "Contract Start Date")
After creation, the field's key is the hash you must use in Deal create/update payloads. Field definitions are cached for 15 minutes — call fields_list_deal_fields after a brief delay to see it reflected.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name of the field | |
| options | No | Required for `enum` and `set` field types | |
| field_type | Yes | Type of the field. `enum`/`set` require `options`. | |
| add_visible_flag | No | Whether the field is shown in the "add" form by default |