logo

Knowledge Base Question

This document describes the API for reading Knowledge Base Questions.

Get a Knowledge Base Question

Returns a single Knowledge Base Question 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_questions/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Update a Knowledge Base Question
Update a Knowledge Base Question by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
query Parameters
content
string
The content of the Knowledge Base Question.


 
manual_review_requested
boolean
Flag to indicate if a manual review of the Knowledge Base Question is requested.


 
owner_id
string <uuid> 
The ID of the owner of the Knowledge Base Question.


 
review_frequency
string
The frequency of the review of the Knowledge Base Question.


 Enum: "Daily" "Weekly" "Biweekly" "Monthly" "Quarterly" "Biannually" "Annually" "Never"  
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


default
put/knowledge_base_questions/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Delete a Knowledge Base Question
Delete a Knowledge Base Question 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_questions/{id}
Request samples 
Create a Knowledge Base Question
Create a new Knowledge Base Question


Securityheader_authorization 
Request 
query Parameters
content
required
string
The content of the Knowledge Base Question.


 
owner_id
string <uuid> 
The ID of the owner of the Knowledge Base Question.


 
review_frequency
string
The frequency of the review of the Knowledge Base Question.


 Enum: "Daily" "Weekly" "Biweekly" "Monthly" "Quarterly" "Biannually" "Annually" "Never"  
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


default
post/knowledge_base_questions
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to Repository