post https://api.talkdeskapp.com/knowledge-management/external-sources
Creates a new external source with the required information to extract articles from the specified source.
Scope
km-external-sources:write
Body Response
200 OK
| Parameter | Type | Description |
|---|---|---|
| details | object | Specific details of the knowledge base. Required. "details" subdivides into: 1 - "description" (string) - The description of the external source. = 1 characters <= 160 characters Example: This is a description. Match pattern: \S+ 2 - "knowledge_type" (string) - The type of the external source. <= 255 characters Allowed value: CUSTOM Example: CUSTOM 3 - "name" (string) - The name of the external source. = 1 characters <= 64 characters Example: External source XPTO. Match pattern: \S+. Required. 4 - "knowledge_segments" (string) The knowledge segments of the external source, separated by commas.= 1 characters <= 1024 characters Example: sales,vip 5- "ring_groups"(array [string]) - The ring groups associated with the external source. Example: ["agents"] 6 - "metadata" (dictionary [string]) A set of arbitrary key-value pairs with additional data about the external source. Example: {"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"KnowledgeOwl"} |
| id | string | The id of the external source. Example: 486d70ae-62ad-4115-a1fd-39ceb87aaa5d |
| enabled | boolean | Determines if the data source should be indexed or not. |
400 (bad request), 401 (Unauthorized access - invalid or unverifiable JWT), 403 (forbidden), 500 (internal server error)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.