Update Company User

patch

https://api.applicant-tracking.com/api/v1/companies/{company_id}/users/{id}

Updates a single user on a company. Only provided fields are changed. Email address changes made with private label authentication take effect immediately, without the email verification step.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

A company id.

string

required

The user identifier.

Body Params

first_name

string

last_name

string

With private label authentication the email is updated immediately, without the email verification step.

phone

string

admin_level

string

One of the account's user levels, e.g. AccountOwner, Admin, Basic, Limited or ReadOnly.

receive_notifications

boolean

Whether the user receives email notifications.

assigned_job_ids

array

Full replacement list of job ids the user is assigned to. Use an empty array to clear job assignments; omit the field to leave assignments unchanged.

assigned_job_ids

assigned_site_ids

array

Full replacement list of site ids the user is assigned to. Requires the multisite feature to be enabled on the company. Use an empty array to clear site assignments; omit the field to leave assignments unchanged.

assigned_site_ids

external_id

string

time_zone

string

mfa_enabled

boolean

Set to false to disable two-factor authentication for the user. Enabling two-factor authentication through the API is not supported.

Responses

403

Not authorized

404

Record not found. Please check to make sure that the specified ID is valid.

500

Internal system error. Please contact support in the event that this occurs.

200Updated the user.

422Fields were invalid or missing.