Create a user

Creates a new user in your Domo instance.

POST /v1/users

Create a user

cURL

curl --request POST \
  --url https://api.domo.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Software Engineer",
  "email": "[e-mail]",
  "alternateEmail": "[e-mail]",
  "role": "Admin",
  "phone": "888-361-1078",
  "name": "Leonhard Euler",
  "location": "American Fork",
  "timezone": "",
  "locale": "",
  "employeeNumber": 23432
}
'

import requests

url = "https://api.domo.com/v1/users"

payload = {
    "title": "Software Engineer",
    "email": "[e-mail]",
    "alternateEmail": "[e-mail]",
    "role": "Admin",
    "phone": "888-361-1078",
    "name": "Leonhard Euler",
    "location": "American Fork",
    "timezone": "",
    "locale": "",
    "employeeNumber": 23432
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'Software Engineer',
    email: '[e-mail]',
    alternateEmail: '[e-mail]',
    role: 'Admin',
    phone: '888-361-1078',
    name: 'Leonhard Euler',
    location: 'American Fork',
    timezone: '',
    locale: '',
    employeeNumber: 23432
  })
};

fetch('https://api.domo.com/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.domo.com/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Software Engineer',
    'email' => '[e-mail]',
    'alternateEmail' => '[e-mail]',
    'role' => 'Admin',
    'phone' => '888-361-1078',
    'name' => 'Leonhard Euler',
    'location' => 'American Fork',
    'timezone' => '',
    'locale' => '',
    'employeeNumber' => 23432
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.domo.com/v1/users"

	payload := strings.NewReader("{\n  \"title\": \"Software Engineer\",\n  \"email\": \"[e-mail]\",\n  \"alternateEmail\": \"[e-mail]\",\n  \"role\": \"Admin\",\n  \"phone\": \"888-361-1078\",\n  \"name\": \"Leonhard Euler\",\n  \"location\": \"American Fork\",\n  \"timezone\": \"\",\n  \"locale\": \"\",\n  \"employeeNumber\": 23432\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.domo.com/v1/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Software Engineer\",\n  \"email\": \"[e-mail]\",\n  \"alternateEmail\": \"[e-mail]\",\n  \"role\": \"Admin\",\n  \"phone\": \"888-361-1078\",\n  \"name\": \"Leonhard Euler\",\n  \"location\": \"American Fork\",\n  \"timezone\": \"\",\n  \"locale\": \"\",\n  \"employeeNumber\": 23432\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.domo.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Software Engineer\",\n  \"email\": \"[e-mail]\",\n  \"alternateEmail\": \"[e-mail]\",\n  \"role\": \"Admin\",\n  \"phone\": \"888-361-1078\",\n  \"name\": \"Leonhard Euler\",\n  \"location\": \"American Fork\",\n  \"timezone\": \"\",\n  \"locale\": \"\",\n  \"employeeNumber\": 23432\n}"

response = http.request(request)
puts response.read_body

200

{
  "alternateEmail": "[e-mail]",
  "createdAt": "2017-06-12T20:16:59Z",
  "email": "[e-mail]",
  "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[]

Show child attributes

id · integer

image · string

location · string

name · string

phone · string

role · string

title · string

updatedAt · string