Create a custom field
Creates a custom field for one entity type.
Endpoint
POST/custom-fields
Body
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Organization to create the field in. |
entity_type | string | Yes | contact, company, deal, ticket, reservation, sales_document or product. |
name | string | Yes | Display name. Unique among active fields of the same entity type. |
fieldType | string | Yes | See the field types. |
isRequired | boolean | Yes | Whether the app requires a value. |
options | array | For select / multiselect | { "value": string, "order": integer } items. |
system_currency_id | integer | For currency | A currency enabled in the organization. |
key | string | No | Custom key. Defaults to a slug of name; a numeric suffix is added if the key is taken. |
custom_field_category_id | integer | No | Category to show the field under. |
position | integer | No | Sort order. Defaults to the end of the list for this entity type. |
Request
Response
json
Errors
| Status | When |
|---|---|
400 Bad Request | A field with the same name already exists for this entity type, a required attribute is missing, a currency field has no valid system_currency_id, or the currency is not enabled in the organization. |
Report an issue with this documentation
Please log in to report issues with our documentation.