Create An Account

When creating an Account, you must specify the Account Type properties. The Account Type properties are different, depending on the type of Account you are trying to create.

To retrieve which Account Type properties to specify, use the GET /v1/accounts/account-types/ endpoint.

POST /v1/accounts

Create an Account

cURL

curl --request POST \
  --url https://api.domo.com/v1/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": {
    "id": "<string>",
    "properties": {
      "password": "<string>",
      "authenticateBy": "<string>",
      "url": "<string>",
      "username": "<string>"
    }
  }
}
'

import requests

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

payload = {
    "name": "<string>",
    "type": {
        "id": "<string>",
        "properties": {
            "password": "<string>",
            "authenticateBy": "<string>",
            "url": "<string>",
            "username": "<string>"
        }
    }
}
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({
    name: '<string>',
    type: {
      id: '<string>',
      properties: {
        password: '<string>',
        authenticateBy: '<string>',
        url: '<string>',
        username: '<string>'
      }
    }
  })
};

fetch('https://api.domo.com/v1/accounts', 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/accounts",
  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([
    'name' => '<string>',
    'type' => [
        'id' => '<string>',
        'properties' => [
                'password' => '<string>',
                'authenticateBy' => '<string>',
                'url' => '<string>',
                'username' => '<string>'
        ]
    ]
  ]),
  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/accounts"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": {\n    \"id\": \"<string>\",\n    \"properties\": {\n      \"password\": \"<string>\",\n      \"authenticateBy\": \"<string>\",\n      \"url\": \"<string>\",\n      \"username\": \"<string>\"\n    }\n  }\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/accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"type\": {\n    \"id\": \"<string>\",\n    \"properties\": {\n      \"password\": \"<string>\",\n      \"authenticateBy\": \"<string>\",\n      \"url\": \"<string>\",\n      \"username\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"type\": {\n    \"id\": \"<string>\",\n    \"properties\": {\n      \"password\": \"<string>\",\n      \"authenticateBy\": \"<string>\",\n      \"url\": \"<string>\",\n      \"username\": \"<string>\"\n    }\n  }\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "valid": true,
  "type": {
    "id": "<string>",
    "properties": {}
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

name · string

The name of the Account

type · array

The Account Type object indicating the type of Account

Body

application/json

name · string

type · object

Show child attributes

Response

200 - application/json

Returns an Account object when successful. The returned object will not contain any properties within the Account Type object .

id · string

name · string

valid · boolean

type · object

Show child attributes