Create User

Creates a user in the authenticated Hover organization

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

This endpoint creates a new Hover user and adds them to the authenticated organization. You can also give each user an ID from your own system, such as an employee ID, using preferred_identifier. On success, the API returns 201 Createdwith the new user.

A few things to know:

  • This endpoint only creates new accounts: if the email already belongs to a Hover user, the request returns 422.
  • Each preferred_identifier must be unique within the organization, and a duplicate also returns 422.
  • New users get an invitation email to set their own, but only when the request names an acting user with current_user_id or current_user_email. If you authenticate with an organization token and leave both out, the user is created without an invitation. Fields the API doesn’t recognize are ignored, not rejected, so check the response to confirm your values were saved

Sample Request Body

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

{
  "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",
    "require_job_approval": false
  }
}
Path Params
string
required

Hover organization ID

Body Params
string

ID of the Hover user the API request acts on behalf of. The new user gets an invitation email only when an acting user is set. Use this or current_user_email, not both.

string

Email of the Hover user the API request acts on behalf of. The new user gets an invitation email only when an acting user is set. Use this or current_user_id, not both.

user
object
required
Responses

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