POST /rest/v1.0/workforce-planning/v2/companies/{company_id}/custom-fields/{field_id}
Updates an existing Custom Field for a given company ID. The type property cannot be modified after creation.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
field_id |
String | Yes |
UUID of the Custom Field. |
company_id |
Yes |
Unique identifier for the company. This parameter accepts both formats:
A proxy layer automatically handles both formats, but using the Procore company ID is preferred for consistency with other Procore APIs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
can_filter |
Boolean | No |
If true, allows this field to be used as a filter. |
values[] |
Array | No |
Only applicable for |
name |
String | No |
The updated name of the Custom Field. |
description |
String | No |
A description to help Admin users understand the field’s purpose. |
on_projects |
Boolean | No |
If true, the field is available on Projects. |
integration_only |
Boolean | No |
If true, only integrations can update this field. |
on_people |
Boolean | No |
If true, the field is available on People. |
sort_by |
String | No |
Controls sorting of dropdown values. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.