Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Users

Creates a new user

Creates a new user with the provided email address and password. This endpoint does not generate an email to send to the user. Users created through the web app get an auto-generated password emailed to them. Due to the password being a part of this endpoint's request body, this email is not necessary.

post/users

Request body

first_namestring

First name of the user.

last_namestring

Last name of the user.

is_administratorboolean

If this user is an administrator. Administrators always have access to all dashboards, as well as the ability to change all settings for an account.

emailstring

Email address of the user. The email address functions as the user's username, and so a single email address cannot be shared between several Text Request accounts.

passwordstring

Password for the user to access their account.

external_user_idstring

The external id of the user. The external id is only used as part of the api to label users for filtering and searching. Multiple users can have the same external id.

Example request

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@wefixwindows.com",
  "password": "8aw5vm232b4xkjdr",
  "external_user_id": "johndoe_1",
  "permissions": [
    {
      "dashboard_id": 121,
      "role": "manager"
    }
  ]
}

Response

The new user.

idinteger

The user identifier. Required to update or delete users.

first_namestring

First name of the user.

last_namestring

Last name of the user.

is_administratorboolean

If this user is an administrator. Administrators always have access to all dashboards, as well as the ability to change all settings for an account.

emailstring

Email address of the user. The email address functions as the user's username.

external_user_idstring

The external id of the user. The external id is only used as part of the api to label users for filtering and searching. Multiple users can have the same external id.

Example response

{
  "id": 508,
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@wefixwindows.com",
  "external_user_id": "johndoe_1",
  "permissions": [
    {
      "dashboard_id": 121,
      "role": "manager"
    }
  ]
}