POST /rest/v1.0/workforce-planning/v2/companies/{company_id}/people/{person_id}
Updates a Person for a given company and person ID
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
person_id |
Integer | Yes |
Unique identifier for the person |
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_receive_sms |
Boolean | No |
Determines if the Person can receive SMS notifications. |
hired_date |
String | No |
Date the Person was hired. Accepts ISO Date String, UTC Date String, or MS Numeric Epoch Time. |
first_name |
String | No |
First Name of the Person. |
city_town |
String | No |
The city or town where the Person is located. |
group_ids[] |
Array | No |
Array of UUIDs representing the Groups this Person belongs to. Cannot be empty for an assignable resource or a non-admin Person. |
email |
String | No |
The email that the Person will log in with. Required if updating |
permission_level_id |
String | No |
UUID of the Permission Level assigned to the Person. Required when setting |
emergency_contact_name |
String | No |
Name of the Person's emergency contact. |
country |
String | No |
The country where the Person is located. |
job_title_id |
String | No |
UUID reference to a Job Title in the LaborChart System. |
language |
String | No |
Language preference. Currently only Possible values:
|
notification_profile_id |
String | No |
UUID of the Notification Profile for the user. |
state_province |
String | No |
The state or province where the Person is located. |
emergency_contact_email |
String | No |
Email address of the emergency contact. |
status |
String | No |
The status of the Person. Possible values:
|
employee_number |
String | No |
Internal employee identifier. |
dob |
String | No |
Date of birth of the Person. Accepts ISO Date String, UTC Date String, or MS Numeric Epoch Time. |
is_male |
Boolean | No |
Specifies if the Person identifies as male. |
hourly_wage |
Number | No |
Hourly wage rate for the Person. Used for automatic spend tracking. |
emergency_contact_relation |
String | No |
The relationship between the Person and their emergency contact. |
can_receive_email |
Boolean | No |
Determines if the Person can receive email notifications. |
last_name |
String | No |
Last Name of the Person. |
phone |
String | No |
The Person's phone number, including country and area code. Must be unique among all registered People. |
address_1 |
String | No |
First part of the Person's address. |
is_assignable |
Boolean | No |
Determines if the Person can be assigned to tasks. |
address_2 |
String | No |
Second part of the Person's address (e.g., Apartment, Suite, Unit). |
can_receive_mobile |
Boolean | No |
Determines if the Person can receive mobile push notifications if they have the app installed. Default value: true |
zipcode |
String | No |
The postal/zip code of the Person. |
emergency_contact_number |
String | No |
Phone number of the emergency contact. |
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.