FruxonDocs
ApiKnowledge bases

Withdraws a notice

A conversation that was given the notice is told on its next turn that it ended, so the agent can correct what it said because of it. Withdrawing a notice that already ended changes nothing and succeeds.

POST
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/notices/{notice}:withdraw

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

knowledgeBase*string

The knowledge base id.

Formatuuid
notice*string

The notice id.

Formatuuid
tenant*string

The tenant identifier

Request Body

An optional note.

note?string|null

Why, in a few words ("fixed in 4.12.1").

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/notices/497f6eca-6276-4993-bfeb-53cbbbba6f08:withdraw" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "knowledgeBaseId": "00000000-0000-0000-0000-000000000000",
  "title": "string",
  "body": "string",
  "validUntil": 0,
  "timeZone": "string",
  "active": false,
  "endedAt": 0,
  "createdAt": 0,
  "createdBy": "string",
  "modifiedAt": 0,
  "modifiedBy": "string",
  "withdrawnAt": 0,
  "withdrawnBy": "string",
  "withdrawNote": "string",
  "reactivatesId": "00000000-0000-0000-0000-000000000000",
  "source": "UI",
  "sourceDetail": "string",
  "events": [
    {
      "at": 0,
      "by": "string",
      "action": "POSTED",
      "note": "string"
    }
  ]
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}