FruxonDocs
ApiKnowledge bases

Posts a notice

The body is given to agents whole, so it is limited to 1,200 characters; by convention it follows four headings: what is happening, applies when, tell the customer, do not. A base can have at most ten active notices (409 `notice_limit`), and a notice ends at most 30 days after it is posted (409 `notice_too_long`). Pass `reactivatesId` to post an ended notice again.

POST
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/notices

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

The tenant identifier

Request Body

The notice.

title?string
body?string

Markdown, by convention the four-heading template; at most KnowledgeNotice.MaxBodyLength characters.

validUntil?integer

Unix millis it ends: more than a minute and at most 30 days from now.

Formatint64
timeZone?string|null

IANA zone the end was picked in; rendered to the agent in this zone. Null renders UTC.

reactivatesId?string|null

The ended notice this one re-activates, when it does.

Formatuuid
source?string

How it got in; KnowledgeNoticeSource.Api when omitted.

Value in"UNSPECIFIED" | "UI" | "API" | "CLI" | "OPERATOR_AGENT" | "REVIEW" | "WEBHOOK"
sourceDetail?string|null

Where within PostKnowledgeNoticeRequest.Source, when the caller can say.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/notices" \  -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
}