Skip to main content

CreateCustomFieldDefinition registers a new custom field for an object type.

POST 
/api/v1/crm/custom-fields

key must match ^[a-z][a-z0-9_]{0,63}$ and be unique within (organization_id, object_type). Once created, key and field_type cannot be changed.

For picklist and multiselect types, picklist_options must be provided. Structure: {"options": ["Opt A", "Opt B", ...]}.

Errors:

  • INVALID_ARGUMENT: validation failure (bad key pattern, unsupported type, picklist without options).
  • ALREADY_EXISTS: key already in use for this object type in the org.

Request​

Responses​

A successful response.