Update User

Updates a user in the authenticated Hover organization

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint updates an existing user in your organization. Use it to change a user’s details, or to set or change their preferred_identifier, which is their ID from your own system, such as an employee ID. On success, the API returns 200 OK with the updated user.

A few things to know:

  • The user must belong to the organization in the URL, or the request returns 404. Organization tokens can also update users in child organizations.
  • Each preferred_identifier must be unique within the organization. A duplicate returns 422, and none of the changes in that request are saved.
  • To clear a user’s preferred_identifier, send an empty value

Sample Request Body


//PATCH https://hover.to/api/v1/orgs/{org_id}/users/USER_ID

{
  "user": {
    "email": "[email protected]",
    "first_name": "Jane",
    "last_name": "Smith",
    "mobile_phone": "+15555550123",
    "office_phone": "+15555550100",
    "time_zone": "Pacific Time (US & Canada)",
    "preferred_identifier": "EMP-004821",
  }
}
Path Params
string
required

Hover organization ID

string
required

ID of the user who is being updated

Body Params
string

ID of the Hover user the API request acts on behalf of. Use this or current_user_email, not both.

string

Email of the Hover user the API request acts on behalf of. Use this or current_user_id, not both.

user
object
required

Fields to update. Include only the fields you want to change.

Responses

404

Not Found. The user doesn't belong to the organization in the URL.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json