PATCH /rest/v1.0/projects/{project_id}/instructions/{id}
Update the specified Instruction.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Instruction ID |
project_id |
Integer | Yes |
Unique identifier for the project. |
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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
send_emails |
Boolean | No |
Designates whether or not emails will be sent (default false) |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
instruction |
Object | Yes | |
instruction.description |
String | No |
The Description of the Instruction |
instruction.distribution_member_ids[] |
Array | No |
An array of IDs of the Distributions of the Instruction |
instruction.number |
String | No |
The Number of the Instruction |
instruction.upload_ids[] |
Array | No |
The specified array of upload ids is saved as Site Instruction Attachments. |
instruction.status |
String | No |
The Status of the Instruction Possible values:
|
instruction.cost_impact |
Object | No |
The Cost Impact of the Instruction |
instruction.cost_impact.status |
String | No |
The Status of the Cost Impact Possible values:
|
instruction.cost_impact.value |
Number | No |
Cost impact value in dollars |
instruction.date_received |
String | No | |
instruction.attention_ids[] |
Array | No |
An array of IDs of the Attentions of the Instruction |
instruction.schedule_impact |
Object | No |
The Schedule Impact of the Instruction |
instruction.schedule_impact.status |
String | No |
The Status of the Schedule Impact Possible values:
|
instruction.schedule_impact.value |
Integer | No |
The Value in days of the Schedule Impact |
instruction.instruction_from_id |
Integer | No |
ID of the User who the Instruction is from |
instruction.attachments[] |
Array | No |
Instruction's Attachments.
To upload attachments you must upload the entire payload as |
instruction.trade_ids[] |
Array | No |
An array of IDs of the Trades of the Instruction |
instruction.title |
String | No |
The Title of the Instruction |
instruction.private |
Boolean | No |
The Private status of the Instruction Default value: false |
instruction.instruction_type_id |
Integer | No |
ID of the Instruction Type |
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.