Create Custom Field Definitions
create_custom_field_definitionsCreate a custom field definition in Procore by providing company ID, label, and data type. Returns the new definition's ID for use in creating custom field LOV entries.
Instructions
Creates a Custom Field Definition. The ID returned is then used as a path parameter (custom_field_definition_id) on the Create Custom LOV Entries endpoint. Pass the record's fields as top-level arguments — they are nested under "custom_field_definition" in the request payload for you. company_id defaults to the value set by procore_set_config when omitted. Creates the custom field definition and returns it with its new id (HTTP 201); calling it again creates another record. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: company_id, label, data_type. Procore API (v2.0): Company Admin > Custom - Configurable Tools. Endpoint: POST /rest/v2.0/companies/{company_id}/custom_field_definitions
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | Query string parameter — controls which fields are returned for each Custom Field Definition. 'with_configurable_field_sets' additionally includes the configurable_field_sets array listing the field sets that use the defin... | |
| label | Yes | JSON request body field — the label for this Custom - Configurable Tools operation | |
| active | No | JSON request body field — whether the custom field is active or not. | |
| variant | No | JSON request body field — the variant of the Custom Field. The supported variants is dependent on the data_type. | |
| data_type | Yes | JSON request body field — type of Custom field | |
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| description | No | JSON request body field — the description for this Custom - Configurable Tools operation | |
| default_value | No | JSON request body field — the default value for the Custom Field. Only accepted for read_only rich_text fields. | |
| custom_field_lov_entries | No | JSON request body field — list-of-value entries (selectable options) for the Custom Field. Only applicable to lov_entry and lov_entries data types. |