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

Behavior

Turns a website on or off for this line. DISABLED stops this line’s receptionist answering from it and keeps the website and its crawled text, so you can put it back with ACTIVE without crawling it again. Other lines of your team are not affected. Sending ACTIVE for a website of your team’s library that this line does not use yet adds it to this line. The {id} path parameter is a website id from Get configuration, under knowledge.websites. Ids from before the move to knowledge libraries are no longer valid: read them again from Get configuration.

Errors

  • 404 AGENT_KNOWLEDGE_NOT_FOUND: no website with that id in your team’s library. A file id sent here 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:

"ksrc-abc123"

Body

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

Response

The entry after the write

data
object

A website of the team's knowledge library, crawled for the receptionist to answer from. The crawled text itself is not reported: it is what the receptionist reads, not something you configure.