Create Field Rule (Project Scope)
create_field_rule_project_scopeCreate a project-scoped field defaults rule to override the company's field configuration for that project. Define the field's value and editability, with unique scope among active rules.
Instructions
Creates a project-scoped FIELD_DEFAULTS rule. The rule fully overrides the company configuration for its field at this project (value + editability). The asset type must be visible at the project, and the (asset type, fieldset, trigger field) scope must be unique among the project's active rules. company_id and project_id default to the values set by procore_set_config when omitted. Creates the field rule 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, project_id, trigger_field, definition. Procore API (v2.0): Core > Assets. Endpoint: POST /rest/v2.0/companies/{company_id}/projects/{project_id}/assets/settings/field_rules/create
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rule_name | No | JSON request body field — display name for the rule. Optional: when omitted or blank, the backend auto-generates a scope-indicative name of the form '{rule_type}::{company_id}::{asset_type_id|NA}::{fieldset_id|NA}::{trigger... | |
| rule_type | No | JSON request body field — rule type. Defaults to NAMING for backward compatibility. | |
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| definition | Yes | JSON request body field — structured rule definition. Shape depends on ruleType: FieldRuleDefinitionDTO for NAMING, FieldDefaultsDefinitionDTO for FIELD_DEFAULTS. | |
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| description | No | JSON request body field — optional description | |
| fieldset_id | No | JSON request body field — fieldset id (required for FIELD_DEFAULTS). '-1' for Procore default fields; external configurable fieldset id for custom fields. Null for NAMING. | |
| asset_type_id | No | JSON request body field — asset type id (required for FIELD_DEFAULTS; null for NAMING). | |
| trigger_field | Yes | JSON request body field — trigger field. For NAMING: asset_code. For FIELD_DEFAULTS: the field this rule configures (e.g., custom_field_1234, trade_id). | |
| Accept-Language | No | JSON request body field — locale for localized response messages (for example: en, fr-FR, pseudo) |