Skip to main content
PATCH
Enable or disable website knowledge
Required scope: AGENTS_WRITE

Behavior

Turns a website knowledge entry on or off. DISABLED keeps the entry and its scraped text and stops the receptionist answering from it, so you can put it back with ACTIVE without scraping the page again. The {id} path parameter is an entry id from Get configuration, under knowledge.websites.

Errors

  • 404 AGENT_KNOWLEDGE_NOT_FOUND: no entry with that id on this line’s receptionist. An entry belonging to another line answers the same way.
  • 404 PHONE_NUMBER_NOT_FOUND: the number is not one you have access to.

Authorizations

Authorization
string
header
required

Path Parameters

number
string
required

Allo phone number in E.164 format

Example:

"+14155551234"

id
string
required

Identifier of the website knowledge entry, as returned by GET /v2/api/numbers/{number}/agent

Example:

"wkb-abc123"

Body

application/json
status
enum<string>
required
Available options:
ACTIVE,
DISABLED

Response

The entry after the write

data
object

A page Allo scraped and summarized for the receptionist to answer from. The scraped text itself is not reported: it is what the receptionist reads, not something you configure.