Create Company User
create_company_user_v1_3Create a new user within a specified Procore company. Requires company ID, last name, and email address to complete.
Instructions
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. Pass the record's fields as top-level arguments — they are nested under "user" in the request payload for you. company_id defaults to the value set by procore_set_config when omitted. Creates the company user and returns it with its new id (HTTP 201); calling it again creates another record. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: company_id, last_name, email_address. Procore API (v1.3): Core > Directory. Endpoint: POST /rest/v1.3/companies/{company_id}/users
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zip | No | JSON request body field — the Zip code of the Company User | |
| city | No | JSON request body field — the City of the Company User | |
| notes | No | JSON request body field — the Notes (notes, keywords, tags) of the Company User | |
| avatar | No | JSON request body field — the Avatar of the Company User. 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. | |
| address | No | JSON request body field — the Address of the Company User | |
| initials | No | JSON request body field — the Initials of the Company User | |
| is_active | No | JSON request body field — the Active status of the Company User | |
| job_title | No | JSON request body field — the Job Title of the Company User | |
| last_name | Yes | JSON request body field — the Last Name of the Company User | |
| origin_id | No | JSON request body field — the Origin ID of the Company User | |
| vendor_id | No | JSON request body field — the ID of the Vendor of the Company User | |
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| fax_number | No | JSON request body field — the Fax Number of the Company User | |
| first_name | No | JSON request body field — the First Name of the Company User | |
| state_code | No | JSON request body field — the State Code of the Company User (ISO-3166 Alpha-2 format) | |
| bid_contact | No | JSON request body field — sets the user as a bid contact for the vendor it is associated with. `vendor_id` must also be provided for this to be set. | |
| employee_id | No | JSON request body field — the ID of the Employee of the Company User when `user[is_employee]` is set to `true` | |
| is_employee | No | JSON request body field — the Employee status of the Company User | |
| origin_data | No | JSON request body field — the Origin Data of the Company User | |
| country_code | No | JSON request body field — the Country Code of the Company User (ISO-3166 Alpha-2 format) | |
| mobile_phone | No | JSON request body field — the Mobile Phone of the Company User | |
| email_address | Yes | JSON request body field — the Email Address of the Company User. Update requests including this parameter will be rejected unless the requesting user has Directory Admin permissions | |
| business_phone | No | JSON request body field — the Business Phone of the Company User | |
| email_signature | No | JSON request body field — the Email Signature of the Company User | |
| work_classification_id | No | JSON request body field — the ID of the Work Classification for the Company User | |
| business_phone_extension | No | JSON request body field — the Business Phone Extension of the Company User | |
| run_configurable_validations | No | Query string parameter — if true, validations are run for the corresponding Configurable Field Set. | |
| company_permission_template_id | No | JSON request body field — 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 | |
| default_permission_template_id | No | JSON request body field — 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 |