Update Company User
update_company_userUpdates an existing company user's directory record by modifying specified fields such as name, contact info, and permissions. Requires company_id, user id, last name, and email address.
Instructions
Update the specified User. #### 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. Use this to update an existing Directory records (only the supplied fields are changed). Updates the specified Directory records and returns the modified object on success. Required parameters: company_id, id, last_name, email_address. Procore API (v1.3): Core > Directory. Endpoint: PATCH /rest/v1.3/companies/{company_id}/users/{id}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| id | Yes | URL path parameter — unique identifier of the Directory resource | |
| run_configurable_validations | No | Query string parameter — if true, validations are run for the corresponding Configurable Field Set. | |
| first_name | No | JSON request body field — the First Name of the Company User | |
| last_name | Yes | JSON request body field — the Last Name of the Company User | |
| job_title | No | JSON request body field — the Job Title of the Company User | |
| address | No | JSON request body field — the Address of the Company User | |
| city | No | JSON request body field — the City of the Company User | |
| zip | No | JSON request body field — the Zip code of the Company User | |
| business_phone | No | JSON request body field — the Business Phone of the Company User | |
| business_phone_extension | No | JSON request body field — the Business Phone Extension of the Company User | |
| mobile_phone | No | JSON request body field — the Mobile Phone of the Company User | |
| fax_number | No | JSON request body field — the Fax Number 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 | |
| email_signature | No | JSON request body field — the Email Signature of the Company User | |
| is_active | No | JSON request body field — the Active status of the Company User | |
| is_employee | No | JSON request body field — the Employee status of the Company User | |
| employee_id | No | JSON request body field — the ID of the Employee of the Company User when `user[is_employee]` is set to `true` | |
| notes | No | JSON request body field — the Notes (notes, keywords, tags) of the Company User | |
| country_code | No | JSON request body field — the Country Code of the Company User (ISO-3166 Alpha-2 format) | |
| state_code | No | JSON request body field — the State Code of the Company User (ISO-3166 Alpha-2 format) | |
| initials | No | JSON request body field — the Initials of the Company User | |
| origin_id | No | JSON request body field — the Origin ID of the Company User | |
| origin_data | No | JSON request body field — the Origin Data of the Company User | |
| vendor_id | No | JSON request body field — the ID of the Vendor of the Company User | |
| 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 | |
| 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 | |
| work_classification_id | No | JSON request body field — the ID of the Work Classification for 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. | |
| add_to_new_projects | No | JSON request body field — whether or not this user is added to all new projects. Requests including this parameter will be rejected unless the requesting user has Directory Admin permissions |