Skip to main content
PATCH
Update a hub's name, websites, or notes

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

hubId
string
required

24-character hex id of the knowledge hub (from GET /business/knowledge-hubs).

Body

application/json

At least one of name, websites or notes is required.

name
string

New hub name (1-100 characters).

Required string length: 1 - 100
websites
object[]

Websites to add or re-crawl: at least 1, at most 20 per call, and the 20 caps the call, not the hub. Accepted values for each entry's url: any http(s) web address, with or without the scheme. Merged into the hub's existing websites — on a hub built through this API a known URL is matched ignoring scheme, www., a trailing slash and case — and a match is re-crawled while an unknown URL is added; nothing is ever removed. A matched entry is REPLACED by what you send, so omitting includeSubPages or isCompetitor resets that flag to false. Re-crawling runs in the background after the 202, so a site that cannot be fetched is not reported as an error: its entry simply keeps the lastCrawledAt it already had.

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

Notes to add or update: at least 1, at most 50 per call. Each note's text carries the free-text knowledge itself; filename is only its label. Merged into the hub's existing notes by exact filename: a match keeps its id and its attachment but has its text and isCompetitor overwritten by exactly what you send, so omitting isCompetitor resets that flag to false and a competitor note silently becomes company material; an unknown filename adds a note, and nothing is removed. Two entries with the same filename in one call collapse into one — the last wins, with no error.

Required array length: 1 - 50 elements

Response

Success

knowledgeHub
object
required