FruxonDocs
ApiKnowledge bases

Turns a draft into a knowledge notice and archives the draft.

For a draft true only for now. Two kinds of draft can: one with knowledge from a conversation held during a knowledge notice (`metadata.extractedDuringNotice`), where this is one of the three answers beside publishing it with `noticeDecision=STILL_TRUE` and archiving it; and one an agent review marked as being about something temporary (`metadata.noticeCandidate`). The notice gets `title` and `body`, or the draft's own when omitted, so the body must fit a notice (1,200 characters); a draft that only asks its question needs a `body`. It ends at `validUntil`, or with the notice the draft's conversation was held during while that one is active. The notice is added and the draft archived together, and calling it again returns the same notice. A draft that is a change waiting on a published article cannot become a notice (409 `not_convertible`).

POST
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/documents/{document}:becomeNotice

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
document*string

The draft's id.

Formatuuid
tenant*string

The tenant identifier

Request Body

When the notice ends, and optionally what it says.

validUntil?integer|null

Unix millis the notice ends. Omitted, it ends with the notice the draft's conversation was held during, while that one is still active; required once it has ended, and for a draft no notice was active for.

Formatint64
title?string|null

The notice's title; omitted, the draft's.

body?string|null

The notice's body, by convention the four-heading template; omitted, the draft's. Required for a draft that still only asks its question: "answer needed" is nothing to tell customers.

timeZone?string|null

IANA zone the end is rendered in; omitted, the source notice's.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08:becomeNotice" \  -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"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}