UpdatePortalPageRequest

object

Update a page in a portal.

* Additional properties are NOT allowed.
slugstring

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestring

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstring

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystring

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstring

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

parent_page_idstring(uuid)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example

CreatePortalPageRequest

object

Create a page in a portal.

* Additional properties are NOT allowed.
slugstringrequired

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestring

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystring

Whether a page is publicly accessible to non-authenticated users.
If not provided, the default_page_visibility value of the portal will be used.

Allowed values:publicprivate

Example:public

statusstring

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

parent_page_idstring(uuid)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example

PortalPageInfo

object

Information about a page in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

slugstringrequired

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestringrequired

The title of a page in a portal.

<= 512 characters

Example:My Page

visibilitystringrequired

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstringrequired

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

parent_page_idstring(uuid)required

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

childrenarray[object]required

Information about a page in a portal.

Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","slug":"hello-world","title":"Hello world","visibility":"public","created_at":"2023-01-11T02:30:42.227Z","updated_at":"2023-01-11T02:30:42.227Z","status":"unpublished","parent_page_id":null,"children":[]}

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

PortalSnippetInfo

object

Information about a snippet in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestringrequired

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

visibilitystringrequired

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstringrequired

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

DefaultContent

object

Summary of created default content

* Additional properties are NOT allowed.
pagesarray[string]required
snippetsarray[string]required
Example