PATCH /rest/v1.3/companies/{company_id}/users/sync
This endpoint creates or updates a batch of Company Users. See Using Sync Actions for additional information.
Requires Directory Admin permissions.
Country and State codes
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.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 |
|---|---|---|---|
updates[] |
Array | Yes | |
updates[].job_title |
String | No |
The Job Title of the Company User |
updates[].mobile_phone |
String | No |
The Mobile Phone of the Company User |
updates[].first_name |
String | No |
The First Name of the Company User |
updates[].is_employee |
Boolean | No |
The Employee status of the Company User Default value: false |
updates[].default_permission_template_id |
Integer | No |
The ID of the default Permission Template for the Company User |
updates[].origin_data |
String | No |
The Origin Data of the Company User |
updates[].city |
String | No |
The City of the Company User |
updates[].id |
Integer | No |
The ID of the Company User |
updates[].zip |
String | No |
The Zip code of the Company User |
updates[].origin_id |
String | No |
The Origin ID of the Company User |
updates[].company_permission_template_id |
Integer | No |
The ID of the Company Permission Template for the Company User |
updates[].business_phone |
String | No |
The Business Phone of the Company User |
updates[].business_phone_extension |
Integer | No |
The Business Phone Extension of the Company User |
updates[].vendor_id |
Integer | No |
The ID of the Vendor of the Company User |
updates[].email_address |
String | No |
The Email Address of the Company User |
updates[].fax_number |
String | No |
The Fax Number of the Company User |
updates[].is_active |
Boolean | No |
The Active status of the Company User |
updates[].country_code |
String | No |
The Country Code of the Company User (ISO-3166 Alpha-2 format) |
updates[].initials |
String | No |
The Initials of the Company User |
updates[].work_classification_id |
Integer | No |
The ID of the Work Classification for the Company User |
updates[].last_name |
String | No |
The Last Name of the Company User |
updates[].notes |
String | No |
The Notes (notes, keywords, tags) of the Company User |
updates[].email_signature |
String | No |
The Email Signature of the Company User |
updates[].state_code |
String | No |
The State Code of the Company User (ISO-3166 Alpha-2 format) |
updates[].employee_id |
String | No |
The ID of the Employee of the Company User when |
updates[].avatar |
String | No |
The Avatar of the Company User.
To upload avatar you must upload whole payload as |
updates[].address |
String | No |
The Address of the Company 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.