PATCH /rest/v1.0/projects/{project_id}/users/{id}
Updates the specified project user. The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification.
See Working with Country Codes for additional information. For OK responses with null values, the key will not be returned.
Note: The is_active parameter value requires
a boolean value to be passed in. Setting this parameter to false deactivates the user.
If you have deactivated a user by setting is_active to false and then try to
reactivate the user by setting is_active to true, you will receive an error message.
To reactivate the user via API, you need to call the
Sync Company Users method.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
ID of the user |
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 |
|---|---|---|---|
run_configurable_validations |
Boolean | No |
If true, validations are run for the corresponding Configurable Field Set. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
user |
Object | Yes | |
user.business_phone_extension |
Integer | No |
The Business Phone Extension of the Project User |
user.job_title |
String | No |
The Job Title of the Project User |
user.mobile_phone |
String | No |
The Mobile Phone number of the Project User |
user.vendor_id |
Integer | No |
The Vendor ID of the Project User |
user.abbreviated_name |
String | No |
The Initials of the Project User |
user.email_address |
String | No |
The Email Address of the Project User |
user.fax_number |
String | No |
The Fax Number of the Project User |
user.first_name |
String | No |
The First Name of the Project User |
user.is_active |
Boolean | No |
The Active status of the Project User |
user.is_employee |
Boolean | No |
The Employee status of the Project User Default value: false |
user.country_code |
String | No |
The Country Code of the Project User (ISO-3166 Alpha-2 format) |
user.city |
String | No |
The City in which the Project User resides |
user.last_name |
String | No |
The Last Name of the Project User |
user.notes |
String | No |
The Notes (notes/keywords/tags) of the Project User |
user.email_signature |
String | No |
The Email Signature of the Project User |
user.state_code |
String | No |
The State Code of the Project User (ISO-3166 Alpha-2 format) |
user.zip |
String | No |
The Zip Code of the Project User |
user.business_phone |
String | No |
The Business Phone number of the Project User |
user.employee_id |
String | No |
The Employee ID of the Project User |
user.avatar |
String | No |
Project User Avatar.
To upload avatar you must upload whole payload as |
user.address |
String | No |
The street Address of the Project User |
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.