Update Field Rule (Project Scope)
update_field_rule_project_scopeUpdate a project-scoped field rule's name, description, active status, definition, or fieldset. Scope fields (asset type, trigger field, rule type) are immutable; send only fields to change.
Instructions
Updates a project-scoped field rule's definition / metadata. The rule must belong to the given project. Scope fields (assetTypeId, triggerField, ruleType) cannot be changed. Send only the fields you intend to change; omitted fields keep their current values. company_id and project_id default to the values set by procore_set_config when omitted, and rule_id must identify an existing parent record — resolve it with the matching list tool first. Returns the modified field rule on success. 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, rule_id. Procore API (v2.0): Core > Assets. Endpoint: PUT /rest/v2.0/companies/{company_id}/projects/{project_id}/assets/settings/field_rules/{rule_id}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rule_id | Yes | URL path parameter — unique identifier for the field rule. | |
| is_active | No | JSON request body field — whether the rule is active. Set to false to deactivate. | |
| rule_name | No | JSON request body field — display name for the rule | |
| rule_type | No | JSON request body field — optional metadata. NOT updatable: if provided, must match the existing rule's type; the server rejects mismatches. | |
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| definition | No | JSON request body field — rule definition. Shape must match the rule's stored type — for NAMING, supply expression_fields; for FIELD_DEFAULTS, supply actions. Sent as a raw JSON object; the server converts it to the correct... | |
| 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 — new fieldset id. FIELD_DEFAULTS only; ignored / rejected for NAMING. Provided to recover a rule whose asset type's fieldset has been changed by an admin. Must match the asset type's current fieldse... | |
| Accept-Language | No | JSON request body field — locale for localized response messages (for example: en, fr-FR, pseudo) |