Create a page

Creates a new page in your Domo instance.

POST /v1/pages

Create a page

cURL

curl --request POST \
  --url https://api.domo.com/v1/pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parentId": 123,
  "locked": true,
  "cardIds": [
    123
  ],
  "visibility": {
    "userIds": [
      123
    ],
    "groupIds": [
      123
    ]
  }
}
'

import requests

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

payload = {
    "name": "<string>",
    "parentId": 123,
    "locked": True,
    "cardIds": [123],
    "visibility": {
        "userIds": [123],
        "groupIds": [123]
    }
}
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>',
    parentId: 123,
    locked: true,
    cardIds: [123],
    visibility: {userIds: [123], groupIds: [123]}
  })
};

fetch('https://api.domo.com/v1/pages', 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/pages",
  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>',
    'parentId' => 123,
    'locked' => true,
    'cardIds' => [
        123
    ],
    'visibility' => [
        'userIds' => [
                123
        ],
        'groupIds' => [
                123
        ]
    ]
  ]),
  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/pages"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"parentId\": 123,\n  \"locked\": true,\n  \"cardIds\": [\n    123\n  ],\n  \"visibility\": {\n    \"userIds\": [\n      123\n    ],\n    \"groupIds\": [\n      123\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/pages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"parentId\": 123,\n  \"locked\": true,\n  \"cardIds\": [\n    123\n  ],\n  \"visibility\": {\n    \"userIds\": [\n      123\n    ],\n    \"groupIds\": [\n      123\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"parentId\": 123,\n  \"locked\": true,\n  \"cardIds\": [\n    123\n  ],\n  \"visibility\": {\n    \"userIds\": [\n      123\n    ],\n    \"groupIds\": [\n      123\n    ]\n  }\n}"

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

200

{
  "id": 3242,
  "parentId": 23,
  "owners": [
    {
      "id": 8811501,
      "type": "USER",
      "displayName": "John Smith"
    }
  ],
  "name": "Supply Chain",
  "locked": true,
  "cardIds": [
    12,
    2535,
    233,
    694
  ],
  "visibility": {
    "userIds": [
      793,
      20,
      993,
      19234
    ],
    "groupIds": [
      32,
      25,
      17,
      74
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string

The name of the page

parentId · integer

If provided, the page will be created as a subpage to the page provided

locked · boolean

will restrict other users the ability to make edits to page or its content - the default value is false

cardIds · integer[]

The IDs of all cards to be added to the page

visibility · object

Determines the access given to both individual users or groups within Domo

Show child attributes

Response

200 - application/json

Returns a page object when successful.

id · integer

parentId · integer

owners · object[]

Show child attributes

name · string

locked · boolean

cardIds · integer[]

visibility · object

Show child attributes