PATCH /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{segment_id}/segment_items/update_all
Update All Segment Items with the same attributes. The endpoint handles updating status (deactivating or reactivating) for segment items and their children, including cost types when the cost type deactivation feature is enabled. Deactivating the default cost type (Other) or the last remaining active cost type is not allowed.
For bulk status changes on the Cost types (line item types) segment, attributes must contain only status. Any other property in attributes results in 400 Bad Request with an error message. Other segment types may define their own allowed attributes keys.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
segment_id |
Integer | Yes |
Segment ID |
company_id |
Integer | Yes |
Unique identifier for the company. |
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 |
|---|---|---|---|
attributes |
Object | Yes |
Fields to apply to every selected segment item. For bulk Cost types status updates (when cost type deactivation is enabled), send only |
attributes.status |
String | No |
Segment Item Status Valid values:
|
ids[] |
Array | Yes |
List of segment item IDs. The API will find and update the children of the provided IDs. |
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.