Create Custom Field Metadata
create_custom_field_metadataCreate custom field metadata in Procore by specifying company, field definition, host, source, and position. This sets up configurable custom fields for company objects.
Instructions
Creates a new custom field metadata for the specified Procore company. Pass the record's fields as top-level arguments — they are nested under "custom_field_metadatum" in the request payload for you. company_id defaults to the value set by procore_set_config when omitted. Creates the custom field metadata 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, custom_field_definition_id, host_type, source_type, source_id, position. Procore API (v2.0): Company Admin > Custom - Configurable Tools. Endpoint: POST /rest/v2.0/companies/{company_id}/custom_field_metadata
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| row | No | JSON request body field — row the Field is position on the Form | |
| view | No | Query string parameter — the extended view provides what is shown below. The default view returns the same as the extended view but excludes the attributes company_id, host_type, source_type, source_id, label, data_type, v... | |
| column | No | JSON request body field — column the Field is position on the Form | |
| visible | No | JSON request body field — whether or not the Custom Field Metadatum is visible | |
| position | Yes | JSON request body field — the position for this Custom - Configurable Tools operation | |
| required | No | JSON request body field — whether or not the Custom Field Metadatum is required | |
| host_type | Yes | JSON request body field — procore Entity | |
| source_id | Yes | JSON request body field — configurable FieldSet ID | |
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| source_type | Yes | JSON request body field — configurable FieldSet Class | |
| column_width | No | JSON request body field — how many columns the field spans on the Form | |
| custom_fields_section_id | No | JSON request body field — custom Fields Section ID | |
| custom_field_definition_id | Yes | JSON request body field — custom Field Definition ID |