PATCH /rest/v1.0/companies/{company_id}/people/{id}
Update the specified Company Person.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
ID of the person |
company_id |
Integer | Yes |
ID of 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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
view |
String | No |
Specifies which view of the resource to return (which attributes should be present in the response). If a valid view is not provided, it will default to normal. Valid values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
person |
Object | Yes | |
person.job_title |
String | No |
The Job Title of the Company Person |
person.last_name |
String | Yes |
The Last Name of the Company Person |
person.active |
Boolean | No |
The active status of the Company Person |
person.origin_id |
String | No |
The Origin ID of the Company User |
person.first_name |
String | No |
The First Name of the Company Person |
person.employee_id |
String | No |
The Employee ID of the Company Person |
person.is_employee |
Boolean | No |
The Employee status of the Company Person Default value: false |
person.work_classification_id |
Integer | No |
The unique identifier for the work classification of the Company Person. |
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.