Skip to main content

Create Subpage

Playground

Method: POST Endpoint: /api/content/v1/pages

Request Parameters

Property NameTypeRequiredDescription
parentPageIdStringyesID of the parent page
titleStringyesTitle of the subpage
hasLayoutBooleanno, default is trueWhether the page should have a layout

Example

{
  "method": "POST",
  "url": "https://{instance}.domo.com/api/content/v1/pages",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  },
  "body": {
    "parentPageId": "12345",
    "title": "New Subpage Title",
    "hasLayout": true
  }
}

Response

Success (200): Page created successfully. Forbidden (403): Operation not permitted. Conflict (409): Conflict encountered (e.g., duplicate title).
200:
{
  "pageId": 11111111,
  "parentPageId": 2222222,
  "ownerId": 123123123,
  "owners": [
    {
      "id": 123123123,
      "type": "USER",
      "displayName": null
    }
  ],
  "type": "page",
  "title": "Test Subpage",
  "pageName": "Test Subpage",
  "locked": false,
  "mobileEnabled": true,
  "sharedViewPage": true,
  "metadata": "{\"pageTitle\":\"Test Subpage\",\"title\":\"Test Subpage\",\"type\":\"page\"}",
  "virtualPage": false,
  "hasLayout": true
}

Bulk Move Pages

Playground

Method: PUT Endpoint: /api/content/v1/pages/bulk/move

Request Parameters

Property NameTypeRequiredDescription
pageIdsArray of NumbersyesIDs of pages to move
parentPageIdNumberyesID of the new parent page
pagePermissionStringyesPermission for the pages
Valid Options for pagePermission:
  • "ORIGINAL"

Example

{
  "method": "PUT",
  "url": "https://{instance}.domo.com/api/content/v1/pages/bulk/move",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  },
  "body": {
    "pageIds": [123, 456],
    "parentPageId": 789,
    "pagePermission": "ORIGINAL"
  }
}

Response

Success (200): Pages moved successfully. Forbidden (403): Permission denied. Conflict (409): Conflict encountered (e.g., permission constraints).

Revoke Page Access

Playground

Method: DELETE Endpoint: /api/content/v1/share/page/{pageId}/user/{personId}

Path Parameters

Property NameTypeRequiredDescription
pageIdNumberyesID of the page
personIdNumberyesID of the user

Example

{
  "method": "DELETE",
  "url": "https://{instance}.domo.com/api/content/v1/share/page/12345/user/67890",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  }
}

Response

Success (200): Access revoked successfully. Forbidden (403): Operation not permitted. Conflict (409): Conflict encountered while attempting to revoke access.