Skip to main content
POST
Create webpage resource

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string
required

The title of the webpage resource.

Minimum string length: 1
url
string<uri>
required

The URL of the webpage.

description
string

A description for the webpage resource.

ownerAssignment
object

The actor to assign as owner. Currently only type "User" is supported.

customerVisibility
enum<string>

Customer visibility on the Trust Center.

Available options:
PRIVATE,
SHAREABLE,
REQUEST_ACCESS,
PUBLIC
includeSubPages
boolean

Whether to scan sub-pages one level deep alongside the primary URL.

isUsedInQuestionnaires
boolean

Whether the resource should be used for question-answering in Questionnaire Automation.

expirationDate
string

Expiration date in ISO 8601 format.

tags
object[]

Tags to associate with the resource.

categoryId
string | null

Trust Center category id to associate this resource with. Pass null to keep the resource uncategorized. Only valid when customerVisibility is REQUEST_ACCESS or PUBLIC; other combinations and unknown ids return an InvalidInputError.

Response

200 - application/json

Ok

id
string
required
type
enum<string>
required
Available options:
URL
title
string
required
description
string | null
required
url
string
required
customerVisibility
enum<string> | null
required
Available options:
PRIVATE,
SHAREABLE,
REQUEST_ACCESS,
PUBLIC,
null
includeSubPages
boolean | null
required
isUsedInQuestionnaires
boolean | null
required
ownerAssignment
object | null
required
expirationStatus
enum<string>
required

Customer-facing expiration status used by knowledge-base API responses (answer library entries and resources). Derived from the persisted expiresAt field at read time.

Available options:
CURRENT,
EXPIRED
expirationDate
string | null
required
lastUpdated
string
required
lastVerified
string | null
required
tags
object[]
required
categoryId
string | null
required

Trust Center category id the resource is currently filed under, or null if uncategorized (or not on the Trust Center, which is the case for PRIVATE / SHAREABLE resources).