Skip to main content
POST
/
v1
/
users
Create a user
curl --request POST \
  --url https://api.domo.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Software Engineer",
  "email": "leonhard.euler@domo.com",
  "alternateEmail": "leonhardeuler@email.com",
  "role": "Admin",
  "phone": "888-361-1078",
  "name": "Leonhard Euler",
  "location": "American Fork",
  "timezone": "",
  "locale": "",
  "employeeNumber": 23432
}
'
{
  "alternateEmail": "leonhardeuler@email.com",
  "createdAt": "2017-06-12T20:16:59Z",
  "email": "leonhard.euler@domo.com",
  "employeeNumber": 23432,
  "groups": [
    {
      "id": 1324037627,
      "name": "Default"
    }
  ],
  "id": 959463190,
  "image": "https://instance.domo.com/avatar/thumb/domo/959463190",
  "location": "American Fork",
  "name": "Leonhard Euler",
  "phone": "888-361-1078",
  "role": "Admin",
  "title": "Software Engineer",
  "updatedAt": "2017-06-12T20:16:59Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
name
string
required

User's full name

​
email
string
required

User's primary email used in profile

​
role
string
required

The role of the user created (available roles are: 'Admin', 'Privileged', 'Participant')

​
sendInvite
boolean

Send an email invite to created user

​
title
string

User's job title

​
alternateEmail
string

User's secondary email in profile

​
phone
string

Primary phone number of user

​
location
string

Free text that can be used to define office location (e.g. City, State, Country)

​
timezone
string

Time zone used to display to user the system times throughout Domo application

​
locale
string

Locale used to display to user the system settings throughout Domo application

​
employeeNumber
string

Employee number within company

Body

application/json
​
title
string
​
email
string
​
alternateEmail
string
​
role
string
​
phone
string
​
name
string
​
location
string
​
timezone
string
​
locale
string
​
employeeNumber
integer

Response

200 - application/json

Returns a user object when successful. The returned object will have user attributes based on the information that was provided when user was created. The two exceptions of attributes not returned are the user's timezone and locale.

​
alternateEmail
string
​
createdAt
string
​
email
string
​
employeeNumber
integer
​
groups
object[]
​
id
integer
​
image
string
​
location
string
​
name
string
​
phone
string
​
role
string
​
title
string
​
updatedAt
string