Update a page

Updates the specified page by providing values to parameters passed. Any parameter left out of the request will cause the specific page’s attribute to remain unchanged.

Also, collections cannot be added or removed via this endpoint, only reordered. Giving access to a user or group will also cause that user or group to have access to the parent page (if the page is a subpage). Moving a page by updating the parentId will also cause everyone with access to the page to have access to the new parent page.

PUT /v1/pages/{page_id}

Update a page

cURL

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

import requests

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

payload = {
    "name": "<string>",
    "owners": [
        {
            "id": 123,
            "type": "<string>",
            "displayName": "<string>"
        }
    ],
    "parentId": 123,
    "locked": True,
    "collectionIds": [123],
    "cardIds": [123],
    "visibility": {
        "userIds": [123],
        "groupIds": [123]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    owners: [{id: 123, type: '<string>', displayName: '<string>'}],
    parentId: 123,
    locked: true,
    collectionIds: [123],
    cardIds: [123],
    visibility: {userIds: [123], groupIds: [123]}
  })
};

fetch('https://api.domo.com/v1/pages/{page_id}', 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/{page_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'owners' => [
        [
                'id' => 123,
                'type' => '<string>',
                'displayName' => '<string>'
        ]
    ],
    'parentId' => 123,
    'locked' => true,
    'collectionIds' => [
        123
    ],
    '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/{page_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"owners\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ],\n  \"parentId\": 123,\n  \"locked\": true,\n  \"collectionIds\": [\n    123\n  ],\n  \"cardIds\": [\n    123\n  ],\n  \"visibility\": {\n    \"userIds\": [\n      123\n    ],\n    \"groupIds\": [\n      123\n    ]\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.domo.com/v1/pages/{page_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"owners\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ],\n  \"parentId\": 123,\n  \"locked\": true,\n  \"collectionIds\": [\n    123\n  ],\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/{page_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"owners\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ],\n  \"parentId\": 123,\n  \"locked\": true,\n  \"collectionIds\": [\n    123\n  ],\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

Authorizations

Authorization · string · header · required

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

Path Parameters

page_id · string · required

The ID of the page

Example:

"876655018"

Body

application/json

name · string

Will update the name of the page

owners · object[]

Will update the owners of the page

Show child attributes

parentId · integer

If provided, will either make the page a subpage or simply move the subpage to become a child of a different parent page

locked · boolean

Will restrict access to edit page

collectionIds · integer[]

Collections cannot be added or removed but the order can be updated based on the order of IDs provided in the argument

cardIds · integer[]

IDs provided will add or remove cards that are not a part of a page collection

visibility · object

Shares pages with users or groups

Show child attributes

Response

200

Returns the parameter of success or error based on the page ID being valid.