Allo

Enable or disable a website

Turns a website on or off for this line without losing its crawled content. ACTIVE on a website of the team's library that this line does not use yet adds it…

PATCH/v2/api/numbers/{number}/agent/knowledge/websites/{id}

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.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

numberstringrequired

Allo phone number in E.164 format

idstringrequired

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

Body

statusenum<string>required

ACTIVEDISABLED

Responses

200The entry after the write
dataobject

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.

5 fields
idstring
urlstring
statusenum<string>

ACTIVE when this line's receptionist answers from the website, DISABLED when this line does not use it.

ACTIVEDISABLED

created_atstring<date-time> | null
updated_atstring<date-time> | null
400
401
403
404
429