POST /rest/v1.3/companies/{company_id}/users
Create a new User in the specified Company.
Uploading avatar
To upload avatar you must upload whole payload as multipart/form-data content-type and
specify each parameter as form-data together with user[avatar] as file.
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. |
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.job_title |
String | No |
The Job Title of the Company User |
user.mobile_phone |
String | No |
The Mobile Phone of the Company User |
user.first_name |
String | No |
The First Name of the Company User |
user.is_employee |
Boolean | No |
The Employee status of the Company User Default value: false |
user.default_permission_template_id |
Integer | No |
The ID of the default Permission Template for the Company User. Requests including this parameter will be rejected unless the requesting user has Directory Admin permissions |
user.origin_data |
String | No |
The Origin Data of the Company User |
user.city |
String | No |
The City of the Company User |
user.zip |
String | No |
The Zip code of the Company User |
user.origin_id |
String | No |
The Origin ID of the Company User |
user.company_permission_template_id |
Integer | No |
The ID of the Company Permission Template for the Company User. Requests including this parameter will be rejected unless the requesting user has Directory Admin permissions |
user.business_phone |
String | No |
The Business Phone of the Company User |
user.business_phone_extension |
Integer | No |
The Business Phone Extension of the Company User |
user.vendor_id |
Integer | No |
The ID of the Vendor of the Company User |
user.email_address |
String | Yes |
The Email Address of the Company User. Update requests including this parameter will be rejected unless the requesting user has Directory Admin permissions |
user.fax_number |
String | No |
The Fax Number of the Company User |
user.is_active |
Boolean | No |
The Active status of the Company User |
user.country_code |
String | No |
The Country Code of the Company User (ISO-3166 Alpha-2 format) |
user.initials |
String | No |
The Initials of the Company User |
user.work_classification_id |
Integer | No |
The ID of the Work Classification for the Company User |
user.last_name |
String | Yes |
The Last Name of the Company User |
user.notes |
String | No |
The Notes (notes, keywords, tags) of the Company User |
user.email_signature |
String | No |
The Email Signature of the Company User |
user.state_code |
String | No |
The State Code of the Company User (ISO-3166 Alpha-2 format) |
user.employee_id |
String | No |
The ID of the Employee of the Company User when |
user.avatar |
String | No |
The Avatar of the Company User.
To upload avatar you must upload whole payload as |
user.address |
String | No |
The Address of the Company User |
user.bid_contact |
Boolean | No |
Sets the user as a bid contact for the vendor it is associated with. |
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.