Create a custom field

Creates a custom field for one entity type.

Endpoint

POST
/custom-fields

Body

NameTypeRequiredDescription
organization_idintegerYesOrganization to create the field in.
entity_typestringYescontact, company, deal, ticket, reservation, sales_document or product.
namestringYesDisplay name. Unique among active fields of the same entity type.
fieldTypestringYesSee the field types.
isRequiredbooleanYesWhether the app requires a value.
optionsarrayFor select / multiselect{ "value": string, "order": integer } items.
system_currency_idintegerFor currencyA currency enabled in the organization.
keystringNoCustom key. Defaults to a slug of name; a numeric suffix is added if the key is taken.
custom_field_category_idintegerNoCategory to show the field under.
positionintegerNoSort order. Defaults to the end of the list for this entity type.

Request

Response

json

Errors

StatusWhen
400 Bad RequestA 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.