Skip to main content
PATCH
Update a knowledge hub

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

hubId
string
required

The knowledge hub's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Body

application/json
name
string

A new name.

Required string length: 1 - 100
websites
object[]

1 to 20 sites to add, or to read again when the hub has them. A site the hub has is replaced by what you send, so includeSubPages and isCompetitor left out become false. Nothing is removed.

Required array length: 1 - 20 elements
notes
object[]

1 to 50 notes to add or replace, by filename. Nothing is removed.

Required array length: 1 - 50 elements

Response

The knowledge hub, processing while its sites are read.

id
string
required
name
string
companyName
string
status
string

processing while it is built, then complete, or draft when building failed.

isDefault
boolean

The hub campaigns use when they name none.

createdAt
string<date-time>
websites
object[]
notes
object[]
updatedAt
string<date-time>