Knowledge Base Answer

This document describes the API for reading Knowledge Base Answers.

Get a Knowledge Base Answer

Returns a single Knowledge Base Answer by ID

Securityheader_authorization
Request
path Parameters
id
required
string

Scope response to id

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource not found

default
get/knowledge_base_answers/{id}
Request samples
Response samples
application/json
{
  • "data": {
    },
  • "includes": { }
}

Update a Knowledge Base Answer

Update a Knowledge Base Answer by ID

Securityheader_authorization
Request
path Parameters
id
required
string

Scope response to id

query Parameters
content
string

The content of the Knowledge Base Answer.

primary_answer
boolean

Flag to indicate if this is the primary answer.

type
string

The type of the Knowledge Base Answer.

Enum: "KnowledgeBaseAnswerFreeForm" "KnowledgeBaseAnswerYesOrNo" "KnowledgeBaseAnswerTrueOrFalse"
Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
put/knowledge_base_answers/{id}
Request samples
Response samples
application/json
{
  • "data": {
    },
  • "includes": { }
}

Delete a Knowledge Base Answer

Delete a Knowledge Base Answer by ID

Securityheader_authorization
Request
path Parameters
id
required
string

Scope response to id

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource not found

delete/knowledge_base_answers/{id}
Request samples

Create a Knowledge Base Answer

Create a new Knowledge Base Answer

Securityheader_authorization
Request
query Parameters
content
required
string

The content of the Knowledge Base Answer.

knowledge_base_question_id
required
string <uuid>

The ID of the associated Knowledge Base Question.

primary_answer
boolean

Flag to indicate if this is the primary answer.

type
required
string

The type of the Knowledge Base Answer.

Enum: "KnowledgeBaseAnswerFreeForm" "KnowledgeBaseAnswerYesOrNo" "KnowledgeBaseAnswerTrueOrFalse"
Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
post/knowledge_base_answers
Request samples
Response samples
application/json
{
  • "data": {
    },
  • "includes": { }
}