{ "openapi":"3.1.0", "info":{ "title":"Infobip OpenAPI Specification", "description":"OpenAPI Specification that contains all public endpoints and webhooks.", "contact":{ "name":"Infobip support", "email":"support@infobip.com" }, "version":"3.210.0", "x-generatedAt":"2026-07-23T15:23:59.777615553Z" }, "tags":[ { "name":"customer-engagement", "description":"Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.\n", "x-type":"category", "x-displayName":"Customer Engagement" }, { "name":"knowledge-base", "description":"Knowledge Base is a centralized content management system for creating, organizing, and retrieving articles, attachments, and structured content. Content is organized into categories, folders, and a hierarchical content tree. Articles support draft and published workflow statuses, tagging, commenting, and file attachments.", "x-type":"product", "x-displayName":"Knowledge Base" }, { "name":"knowledge-base-search", "description":"", "x-type":"section", "x-displayName":"Search" }, { "name":"knowledge-base-articles", "description":"", "x-type":"section", "x-displayName":"Articles" }, { "name":"knowledge-base-categories", "description":"", "x-type":"section", "x-displayName":"Categories" }, { "name":"knowledge-base-folders", "description":"", "x-type":"section", "x-displayName":"Folders" }, { "name":"knowledge-base-content-tree", "description":"", "x-type":"section", "x-displayName":"Content Tree" }, { "name":"knowledge-base-tags", "description":"", "x-type":"section", "x-displayName":"Tags" }, { "name":"knowledge-base-attachments", "description":"", "x-type":"section", "x-displayName":"Attachments" } ], "paths":{ "/knowledge-base/1/search":{ "post":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-search" ], "summary":"Search knowledge base", "description":"Performs a full-text search across all knowledge base content using filter criteria provided in the request body. Results are paginated.", "operationId":"search-knowledge-base", "parameters":[ { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":5000, "minimum":1 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.SearchCriteria" } } }, "required":true }, "responses":{ "200":{ "description":"Search results returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCatalogRecordListItemResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/articles":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Get articles", "description":"Returns a paginated list of articles. Optionally filter by search expression, tag, or workflow status. Results are sorted by last updated date in descending order by default.", "operationId":"get-articles", "parameters":[ { "name":"searchExp", "in":"query", "description":"Search expression to filter articles by name or content.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"SMS API" }, { "name":"tag", "in":"query", "description":"Filter articles by tag name.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"sms" }, { "name":"status", "in":"query", "description":"Filter by workflow status.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus" }, "example":"PUBLISHED" }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":5000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sort criteria in format 'field,direction'. Sortable fields: name, createdAt, lastUpdatedAt, workflowStatus, lastPublishedAt.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "default":"lastUpdatedAt,desc" }, "example":"lastUpdatedAt,desc" } ], "responses":{ "200":{ "description":"Articles returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleListItemResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Create article", "description":"Creates a new knowledge base article with the provided content, tags, and category assignment.", "operationId":"create-article", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateUpdateArticleRequest" } } }, "required":true }, "responses":{ "201":{ "description":"Article created successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/articles/{articleId}":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Get article", "description":"Returns the full details of a specific article including its content, metadata, and tags. Optionally records a view for analytics.", "operationId":"get-article", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name":"recordView", "in":"query", "description":"Whether to record a page view for analytics.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean", "default":true }, "example":true } ], "responses":{ "200":{ "description":"Article details returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleDetailResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Update article", "description":"Updates an existing knowledge base article with the provided content, tags, and category assignment.", "operationId":"update-article", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateUpdateArticleRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Article updated successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Delete article", "description":"Soft-deletes a knowledge base article by its identifier.", "operationId":"delete-article", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "204":{ "description":"Article deleted successfully" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/articles/{articleId}/status":{ "patch":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Update article status", "description":"Changes the workflow status of an article to PUBLISHED or DRAFT.", "operationId":"update-article-status", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateArticleStatusRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Article status updated successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/articles/{articleId}/history":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Get article versions", "description":"Returns a paginated list of historical versions for a specific article, sorted by version ID in descending order by default.", "operationId":"get-article-versions", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":5000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sort criteria in format 'field,direction'.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "default":"catalogRecordVersionId,desc" }, "example":"catalogRecordVersionId,desc" } ], "responses":{ "200":{ "description":"Article versions returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleVersionDetailResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/articles/{articleId}/comments":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Get article comments", "description":"Returns all comments for a specific article.", "operationId":"get-article-comments", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "200":{ "description":"Comments returned successfully", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentListItemResponse" } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Create comment", "description":"Adds a new comment to a specific article.", "operationId":"create-article-comment", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentCreateUpdateRequest" } } }, "required":true }, "responses":{ "201":{ "description":"Comment created successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentRefResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/articles/{articleId}/comments/{commentId}":{ "put":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Update comment", "description":"Updates the content of a specific comment on an article.", "operationId":"update-article-comment", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name":"commentId", "in":"path", "description":"Unique identifier of the comment.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"1fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentCreateUpdateRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Comment updated successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentRefResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-articles" ], "summary":"Delete comment", "description":"Deletes a specific comment from an article. Only the comment author or users with manage permissions can delete.", "operationId":"delete-article-comment", "parameters":[ { "name":"articleId", "in":"path", "description":"Unique identifier of the article.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name":"commentId", "in":"path", "description":"Unique identifier of the comment.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"1fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "204":{ "description":"Comment deleted successfully" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/categories":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-categories" ], "summary":"Get categories", "description":"Returns a paginated list of categories. Optionally filter by category name or content scope. Results are sorted by name in ascending order by default.", "operationId":"get-categories", "parameters":[ { "name":"name", "in":"query", "description":"Filter categories by name.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"API Guides" }, { "name":"scope", "in":"query", "description":"Filter categories by content scope.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope" }, "example":"INTERNAL" }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":5000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sort criteria in format 'field,direction'.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "default":"name,asc" }, "example":"name,asc" } ], "responses":{ "200":{ "description":"Categories returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCategoryItemResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/folders":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-folders" ], "summary":"Get folders", "description":"Returns a paginated list of folders. Optionally filter by folder name or category. Results are sorted by name in ascending order by default.", "operationId":"get-folders", "parameters":[ { "name":"name", "in":"query", "description":"Filter folders by name.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Getting Started" }, { "name":"categoryId", "in":"query", "description":"Filter folders by category identifier.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":5000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sort criteria in format 'field,direction'.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "default":"name,asc" }, "example":"name,asc" } ], "responses":{ "200":{ "description":"Folders returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageFolderItemResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/content-tree/nodes/categories":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-content-tree" ], "summary":"Get content tree categories", "description":"Returns a paginated list of top-level category nodes in the content tree. Optionally expand the tree to a specific node. Results are sorted by position in ascending order by default.", "operationId":"get-content-tree-categories", "parameters":[ { "name":"expandedToNodeId", "in":"query", "description":"Expand the tree to include the path to this node.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":5000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sort criteria in format 'field,direction'.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "default":"position,asc" }, "example":"position,asc" } ], "responses":{ "200":{ "description":"Content tree categories returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTreeNodeResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/content-tree/nodes":{ "post":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-content-tree" ], "summary":"Create content tree node", "description":"Creates a new node in the content tree.", "operationId":"create-content-tree-node", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateTreeNodeRequest" } } }, "required":true }, "responses":{ "201":{ "description":"Content tree node created successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/content-tree/nodes/{nodeId}/move":{ "post":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-content-tree" ], "summary":"Move content tree node", "description":"Moves a content tree node to a new position relative to a target node.", "operationId":"move-content-tree-node", "parameters":[ { "name":"nodeId", "in":"path", "description":"Unique identifier of the node to move.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.MoveTreeNodeRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Content tree node moved successfully" }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/content-tree/nodes/{nodeId}":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-content-tree" ], "summary":"Get content tree node", "description":"Returns the direct children of a specific content tree node.", "operationId":"get-content-tree-node", "parameters":[ { "name":"nodeId", "in":"path", "description":"Unique identifier of the tree node.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "200":{ "description":"Child nodes returned successfully", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse" } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-content-tree" ], "summary":"Update content tree node", "description":"Updates an existing content tree node.", "operationId":"update-content-tree-node", "parameters":[ { "name":"nodeId", "in":"path", "description":"Unique identifier of the tree node.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateTreeNodeRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Content tree node updated successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-content-tree" ], "summary":"Delete content tree node", "description":"Deletes a content tree node and its children.", "operationId":"delete-content-tree-node", "parameters":[ { "name":"nodeId", "in":"path", "description":"Unique identifier of the tree node.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "204":{ "description":"Content tree node deleted successfully" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/tags":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-tags" ], "summary":"Get tags", "description":"Returns a paginated list of tags. Optionally filter by tag name. Results are sorted by last updated date in descending order by default.", "operationId":"get-knowledge-base-tags", "parameters":[ { "name":"name", "in":"query", "description":"Filter tags by name.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"sms" }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":5000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sort criteria in format 'field,direction'. Sortable fields: name, createdAt, lastUpdatedAt, referencesCount.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "default":"lastUpdatedAt,desc" }, "example":"lastUpdatedAt,desc" } ], "responses":{ "200":{ "description":"Tags returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTagListItemResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-tags" ], "summary":"Create tag", "description":"Creates a new tag with the given name. Tag name must not contain comma characters.", "operationId":"create-knowledge-base-tag", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagCreateRequest" } } }, "required":true }, "responses":{ "201":{ "description":"Tag created successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagRefResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/tags/{tagId}":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-tags" ], "summary":"Get tag", "description":"Returns the details of a specific tag by its identifier.", "operationId":"get-knowledge-base-tag", "parameters":[ { "name":"tagId", "in":"path", "description":"Unique identifier of the tag.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "200":{ "description":"Tag returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagListItemResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-tags" ], "summary":"Update tag", "description":"Renames an existing tag.", "operationId":"update-knowledge-base-tag", "parameters":[ { "name":"tagId", "in":"path", "description":"Unique identifier of the tag.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagUpdateRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Tag updated successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagRefResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/attachments/{attachmentId}":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-attachments" ], "summary":"Get attachment details", "description":"Returns the details of a specific attachment including its metadata and download URL.", "operationId":"get-attachment-details", "parameters":[ { "name":"attachmentId", "in":"path", "description":"Unique identifier of the attachment.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "200":{ "description":"Attachment details returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentDetailResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":50, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-attachments" ], "summary":"Delete attachment", "description":"Deletes an attachment by its identifier.", "operationId":"delete-attachment", "parameters":[ { "name":"attachmentId", "in":"path", "description":"Unique identifier of the attachment.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "204":{ "description":"Attachment deleted successfully" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/attachments/{attachmentId}/linked-article":{ "get":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-attachments" ], "summary":"Get attachment linked article", "description":"Returns the article that is linked to a specific attachment.", "operationId":"get-attachment-linked-article", "parameters":[ { "name":"attachmentId", "in":"path", "description":"Unique identifier of the attachment.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uuid" }, "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses":{ "200":{ "description":"Linked article returned successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentLinkedArticleResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:read", "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/knowledge-base/1/attachments":{ "post":{ "tags":[ "customer-engagement", "knowledge-base", "knowledge-base-attachments" ], "summary":"Upload attachment", "description":"Uploads a file as a new knowledge base attachment. The file is validated and stored.", "operationId":"upload-attachment", "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "format":"binary" } }, "required":[ "file" ] } } } }, "responses":{ "201":{ "description":"Attachment uploaded successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentDetailResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "knowledge-base:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } } }, "components":{ "schemas":{ "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleDetailResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the article.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name":{ "type":"string", "description":"Name of the article.", "example":"Getting Started with SMS API" }, "content":{ "type":"string", "description":"Content of the article in HTML format.", "example":"

Introduction

This guide covers the basics of the SMS API.

" }, "status":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus" }, "tags":{ "type":"array", "description":"Tags assigned to the article.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagSimpleResponse" } }, "links":{ "type":"array", "description":"List of Articles Or Attachments linked to the article.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleLinkDetailResponse" } }, "lastPublishedAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the article was last published.", "example":"2025-06-15T12:00:00Z" }, "createdAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the article was created.", "example":"2025-06-01T08:30:00Z" }, "lastUpdatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the article was last updated.", "example":"2025-06-15T14:20:00Z" }, "likeCount":{ "type":"integer", "format":"int32", "description":"Count of positive feedbacks.", "example":12 }, "likedByUser":{ "type":"boolean", "description":"Whether the current user has liked this article. Null when no user context is available.", "example":false }, "viewCount":{ "type":"integer", "format":"int32", "description":"Total view count.", "example":350 }, "subscribedByUser":{ "type":"boolean", "description":"Whether the current user is subscribed to this article. Null when no user context is available.", "example":true }, "scope":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope" }, "source":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource" }, "category":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryResponse" }, "createdBy":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData" }, "folder":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderResponse" }, "breadcrumb":{ "type":"array", "description":"Navigation breadcrumb path.", "example":[ "Documentation", "API Guides" ], "items":{ "type":"string", "description":"Navigation breadcrumb path.", "example":"[\"Documentation\",\"API Guides\"]" } }, "lastUpdatedBy":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData" }, "lastPublishedBy":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData" }, "commentsCount":{ "type":"integer", "format":"int64", "description":"Number of comments on the article.", "example":5 }, "visibility":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility" }, "publicContentUrl":{ "type":"string", "description":"URL to the public content page.", "example":"https://kb.infobip.com/articles/3fa85f64" } }, "required":[ "breadcrumb", "category", "content", "createdAt", "id", "lastUpdatedAt", "likeCount", "links", "name", "scope", "status", "tags", "viewCount", "visibility" ], "title":"ArticleDetailResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleLinkDetailResponse":{ "type":"object", "description":"List of Articles Or Attachments linked to the article.", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the linked article or attachment.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name":{ "type":"string", "description":"Name of the linked article or attachment.", "example":"API Reference Guide.pdf" }, "type":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.InternalType" } }, "required":[ "id", "name", "type" ], "title":"ArticleLinkDetailResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleListItemResponse":{ "type":"object", "description":"The list of the results for this page.", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the article.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name":{ "type":"string", "description":"Name of the article.", "example":"Getting Started with SMS API" }, "status":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus" }, "tags":{ "type":"array", "description":"Tag names assigned to the article.", "example":[ "sms", "api" ], "items":{ "type":"string", "description":"Tag names assigned to the article.", "example":"[\"sms\",\"api\"]" } }, "lastUpdatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the article was last updated.", "example":"2025-06-15T14:20:00Z" }, "scope":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope" }, "source":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource" }, "visibility":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility" }, "breadcrumb":{ "type":"array", "description":"Navigation breadcrumb path from root to article.", "example":[ "Documentation", "API Guides" ], "items":{ "type":"string", "description":"Navigation breadcrumb path from root to article.", "example":"[\"Documentation\",\"API Guides\"]" } } }, "required":[ "id", "lastUpdatedAt", "name", "scope", "status", "tags", "visibility" ], "title":"ArticleListItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleRefResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the article.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "required":[ "id" ], "title":"ArticleRefResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleVersionDetailResponse":{ "type":"object", "description":"The list of the results for this page.", "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Article version identifier.", "example":42 }, "versionTimestamp":{ "type":"string", "format":"date-time", "description":"Timestamp when this version was created.", "example":"2025-06-15T10:30:00Z" }, "author":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData" }, "workflowStatus":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus" }, "visibility":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility" }, "workflowStatusModified":{ "type":"boolean", "description":"Whether the workflow status was changed in this version.", "example":true }, "contentModified":{ "type":"boolean", "description":"Whether the content was changed in this version.", "example":false }, "nameModified":{ "type":"boolean", "description":"Whether the name was changed in this version.", "example":false }, "tagsAdded":{ "type":"integer", "format":"int32", "description":"Number of tags added in this version.", "example":2 }, "tagsRemoved":{ "type":"integer", "format":"int32", "description":"Number of tags removed in this version.", "example":0 }, "attachmentsAdded":{ "type":"integer", "format":"int32", "description":"Number of attachments added in this version.", "example":1 }, "attachmentsRemoved":{ "type":"integer", "format":"int32", "description":"Number of attachments removed in this version.", "example":0 } }, "required":[ "attachmentsAdded", "attachmentsRemoved", "author", "contentModified", "id", "nameModified", "tagsAdded", "tagsRemoved", "versionTimestamp", "visibility", "workflowStatus", "workflowStatusModified" ], "title":"ArticleVersionDetailResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentDetailResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the attachment.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name":{ "type":"string", "description":"Name of the attachment.", "example":"product-overview.pdf" }, "downloadPublicUrl":{ "type":"string", "description":"Public URL for downloading the attachment from CDN.", "example":"https://cdn.example.com/attachments/product-overview.pdf" }, "publicContentUrl":{ "type":"string", "description":"Public URL for accessing the attachment in Public Content.", "example":"https://public.example.com/attachments/product-overview.pdf" }, "contentType":{ "type":"string", "description":"MIME type of the attachment.", "example":"application/pdf" }, "sizeInBytes":{ "type":"integer", "format":"int64", "description":"Size of the attachment in bytes.", "example":1048576 }, "scope":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope" } }, "required":[ "contentType", "downloadPublicUrl", "id", "name", "scope", "sizeInBytes" ], "title":"AttachmentDetailResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.AttachmentLinkedArticleResponse":{ "type":"object", "properties":{ "articleId":{ "type":"string", "format":"uuid", "description":"Unique identifier of the linked article.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "required":[ "articleId" ], "title":"AttachmentLinkedArticleResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CatalogRecordListItemResponse":{ "type":"object", "description":"The list of the results for this page.", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the article or attachment.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name":{ "type":"string", "description":"Name of the article or attachment.", "example":"Getting Started with SMS API" }, "description":{ "type":"string", "description":"Description or content excerpt of the article or attachment.", "example":"This guide covers the basics of sending SMS messages via the Infobip API." }, "tags":{ "type":"array", "description":"Tags assigned to the record.", "example":[ "sms", "api" ], "items":{ "type":"string", "description":"Tags assigned to the record.", "example":"[\"sms\",\"api\"]" }, "uniqueItems":true }, "type":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.InternalType" }, "scope":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope" }, "url":{ "type":"string", "description":"URL for external content to open or download.", "example":"https://example.com/document.pdf" }, "sizeInBytes":{ "type":"integer", "format":"int64", "description":"Size of attachment in bytes. Present only for attachments.", "example":1048576 }, "contentType":{ "type":"string", "description":"MIME type of attachment. Present only for attachments.", "example":"application/pdf" }, "contentSource":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource" }, "visibility":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility" } }, "required":[ "id", "name", "scope", "tags", "type" ], "title":"CatalogRecordListItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryItemResponse":{ "type":"object", "description":"The list of the results for this page.", "properties":{ "name":{ "type":"string", "description":"Name of the category.", "example":"API Guides" }, "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the category.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "visibility":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility" } }, "required":[ "id", "name", "visibility" ], "title":"CategoryItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryResponse":{ "type":"object", "description":"Parent category of the article.", "properties":{ "name":{ "type":"string", "description":"Name of the category.", "example":"API Guides" }, "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the category.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "required":[ "id", "name" ], "title":"CategoryResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentCreateUpdateRequest":{ "type":"object", "properties":{ "content":{ "type":"string", "description":"Content of the comment.", "example":"Please review the second paragraph for accuracy.", "maxLength":1000, "minLength":0 } }, "required":[ "content" ], "title":"CommentCreateUpdateRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentListItemResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the comment.", "example":"7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "content":{ "type":"string", "description":"Content of the comment.", "example":"Please review the second paragraph for accuracy." }, "createdAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the comment was created.", "example":"2025-06-15T10:30:00Z" }, "createdBy":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData" }, "lastUpdatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the comment was last updated.", "example":"2025-06-15T14:20:00Z" }, "resolved":{ "type":"boolean", "description":"Whether the comment is resolved.", "example":false }, "lastSolver":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData" }, "lastResolvedAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the comment was last resolved or unresolved.", "example":"2025-06-16T09:00:00Z" }, "lastContentUpdatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the comment content was last updated.", "example":"2025-06-15T14:20:00Z" }, "lastContentUpdatedBy":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData" } }, "required":[ "content", "createdAt", "createdBy", "id", "lastContentUpdatedAt", "lastContentUpdatedBy", "lastUpdatedAt", "resolved" ], "title":"CommentListItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CommentRefResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the comment.", "example":"7c9e6679-7425-40de-944b-e07fc1f90ae7" } }, "required":[ "id" ], "title":"CommentRefResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope":{ "type":"string", "description":"Content scope of the node.", "enum":[ "INTERNAL", "EXTERNAL" ], "example":"INTERNAL", "title":"ContentScope" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource":{ "type":"string", "description":"External source of the node, if imported.", "enum":[ "CSV", "SHAREPOINT", "CONFLUENCE" ], "example":"CONFLUENCE", "title":"ContentSource" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility":{ "type":"string", "description":"Visibility of the node.", "enum":[ "PRIVATE", "PUBLIC" ], "example":"PUBLIC", "title":"ContentVisibility" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateTreeNodeRequest":{ "type":"object", "properties":{ "type":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeType" }, "name":{ "type":"string", "description":"Name of the tree node.", "example":"Getting Started" }, "targetId":{ "type":"string", "format":"uuid", "description":"Identifier of the target node for relative positioning.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "position":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.Position" }, "visibility":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility" } }, "required":[ "name", "position", "targetId", "type" ], "title":"CreateTreeNodeRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CreateUpdateArticleRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the article.", "example":"Getting Started with SMS API", "maxLength":255, "minLength":3 }, "content":{ "type":"string", "description":"Content of the article in HTML format.", "example":"

Introduction

This guide covers the basics of the SMS API.

" }, "status":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus" }, "tags":{ "type":"array", "description":"List of tag names to assign to the article.", "example":[ "sms", "api", "getting-started" ], "items":{ "type":"string", "description":"List of tag names to assign to the article.", "example":"[\"sms\",\"api\",\"getting-started\"]" } }, "links":{ "type":"array", "description":"List of attachment identifiers to link to the article.", "example":[ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "items":{ "type":"string", "format":"uuid", "description":"List of attachment identifiers to link to the article." } }, "categoryId":{ "type":"string", "format":"uuid", "description":"Category identifier to assign the article to.", "example":"a1b2c3d4-5678-9012-abcd-ef1234567890" }, "folderId":{ "type":"string", "format":"uuid", "description":"Folder identifier within the category.", "example":"b2c3d4e5-6789-0123-bcde-f12345678901" } }, "required":[ "categoryId", "content", "links", "name", "status", "tags" ], "title":"CreateUpdateArticleRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderItemResponse":{ "type":"object", "description":"The list of the results for this page.", "properties":{ "name":{ "type":"string", "description":"Name of the folder.", "example":"Getting Started" }, "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the folder.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "breadCrumbList":{ "type":"array", "description":"Breadcrumb path from root to this folder.", "example":[ "API Guides", "SMS", "Getting Started" ], "items":{ "type":"string", "description":"Breadcrumb path from root to this folder.", "example":"[\"API Guides\",\"SMS\",\"Getting Started\"]" } } }, "required":[ "breadCrumbList", "id", "name" ], "title":"FolderItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderResponse":{ "type":"object", "description":"Parent folder of the article.", "properties":{ "name":{ "type":"string", "description":"Name of the folder.", "example":"Getting Started" }, "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the folder.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "required":[ "id", "name" ], "title":"FolderResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.InternalType":{ "type":"string", "description":"Type of the record.", "enum":[ "ARTICLE", "ATTACHMENT" ], "example":"ARTICLE", "title":"InternalType" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.MoveTreeNodeRequest":{ "type":"object", "properties":{ "position":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.Position" }, "targetNodeId":{ "type":"string", "format":"uuid", "description":"Identifier of the target node for relative positioning.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "required":[ "position", "targetNodeId" ], "title":"MoveTreeNodeRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleListItemResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleListItemResponse" } }, "paging":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageArticleListItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageArticleVersionDetailResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ArticleVersionDetailResponse" } }, "paging":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageArticleVersionDetailResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCatalogRecordListItemResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CatalogRecordListItemResponse" } }, "paging":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageCatalogRecordListItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageCategoryItemResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.CategoryItemResponse" } }, "paging":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageCategoryItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageFolderItemResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.FolderItemResponse" } }, "paging":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageFolderItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo":{ "type":"object", "description":"Contains information about the page.", "properties":{ "page":{ "type":"integer", "format":"int32", "description":"Requested page number.", "minimum":0 }, "size":{ "type":"integer", "format":"int32", "description":"Requested page size.", "minimum":1 }, "totalPages":{ "type":"integer", "format":"int32", "description":"The total number of pages of the results matching the requested parameters.", "minimum":0 }, "totalResults":{ "type":"integer", "format":"int64", "description":"The total number of the results matching the requested parameters.", "minimum":0 } }, "required":[ "page", "size", "totalPages", "totalResults" ], "title":"PageInfo" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTagListItemResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagListItemResponse" } }, "paging":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageTagListItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageTreeNodeResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse" } }, "paging":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageTreeNodeResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.Position":{ "type":"string", "description":"Position relative to the target node.", "enum":[ "ABOVE", "BELOW", "APPEND" ], "example":"BELOW", "title":"Position" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.SearchCriteria":{ "type":"object", "properties":{ "searchExp":{ "type":"string", "description":"Search expression to filter results by.", "example":"SMS API" }, "filter":{ "type":"object", "additionalProperties":{ "type":"string", "example":"{\"status\":\"PUBLISHED\"}" }, "description":"Key-value filter pairs for advanced search criteria.", "example":{ "status":"PUBLISHED" } } }, "title":"SearchCriteria" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagCreateRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Name for the tag.", "example":"sms-api", "pattern":"^[^,]+$" } }, "required":[ "name" ], "title":"TagCreateRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagListItemResponse":{ "type":"object", "description":"The list of the results for this page.", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the tag.", "example":"c56a4180-65aa-42ec-a945-5fd21dec0538" }, "name":{ "type":"string", "description":"Name of the tag.", "example":"sms" }, "referencesCount":{ "type":"integer", "format":"int32", "description":"Number of articles and attachments tagged with this tag.", "example":8 }, "createdAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the tag was created.", "example":"2025-03-10T09:15:00Z" }, "lastUpdatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp of when the tag was last updated.", "example":"2025-06-15T14:20:00Z" } }, "required":[ "createdAt", "id", "lastUpdatedAt", "name", "referencesCount" ], "title":"TagListItemResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagRefResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the tag.", "example":"c56a4180-65aa-42ec-a945-5fd21dec0538" } }, "required":[ "id" ], "title":"TagRefResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagSimpleResponse":{ "type":"object", "description":"Tags assigned to the article.", "properties":{ "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the tag.", "example":"c56a4180-65aa-42ec-a945-5fd21dec0538" }, "name":{ "type":"string", "description":"Name of the tag.", "example":"sms" } }, "required":[ "id", "name" ], "title":"TagSimpleResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TagUpdateRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"New name for the tag.", "example":"email-api", "pattern":"^[^,]+$" } }, "required":[ "name" ], "title":"TagUpdateRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the tree node.", "example":"Getting Started" }, "id":{ "type":"string", "format":"uuid", "description":"Unique identifier of the tree node.", "example":"3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "parentId":{ "type":"string", "format":"uuid", "description":"Identifier of the parent tree node.", "example":"1fa85f64-5717-4562-b3fc-2c963f66afa6" }, "articleCount":{ "type":"integer", "format":"int32", "description":"Number of articles in this node.", "example":5 }, "position":{ "type":"integer", "format":"int32", "description":"Ordinal position of the node among siblings.", "example":0 }, "type":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeType" }, "hasChildren":{ "type":"boolean", "description":"Whether this node has child nodes.", "example":true }, "childList":{ "type":"array", "description":"Child nodes of this tree node.", "items":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeResponse" } }, "scope":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentScope" }, "source":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentSource" }, "visibility":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.ContentVisibility" }, "root":{ "type":"boolean", "description":"Whether this is a root node.", "example":false } }, "required":[ "articleCount", "id", "name", "parentId", "position", "root", "scope", "type" ], "title":"TreeNodeResponse" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.TreeNodeType":{ "type":"string", "description":"Type of the tree node.", "enum":[ "CATEGORY", "FOLDER", "ARTICLE" ], "example":"FOLDER", "title":"TreeNodeType" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateArticleStatusRequest":{ "type":"object", "properties":{ "status":{ "$ref":"#/components/schemas/09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus" } }, "required":[ "status" ], "title":"UpdateArticleStatusRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UpdateTreeNodeRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"New name of the tree node.", "example":"Getting Started" } }, "required":[ "name" ], "title":"UpdateTreeNodeRequest" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.UserData":{ "type":"object", "description":"User who uploaded the file.", "properties":{ "encryptUserId":{ "type":"string", "description":"Unique encrypted identifier of the user.", "example":"a1b2c3d4e5f6" }, "firstName":{ "type":"string", "description":"First name of the user.", "example":"John" }, "lastName":{ "type":"string", "description":"Last name of the user.", "example":"Doe" } }, "required":[ "encryptUserId", "firstName", "lastName" ], "title":"UserData" }, "09ef6171198229ad9a73a413d2271afa3ba31b9abbd6cd8a0cc9563fd721f1ed.WorkflowStatus":{ "type":"string", "description":"Workflow status of the article.", "enum":[ "PUBLISHED", "DRAFT" ], "example":"PUBLISHED", "title":"WorkflowStatus" }, "ApiError":{ "type":"object", "properties":{ "errorCode":{ "type":"string", "description":"An error code uniquely identifying the error case." }, "description":{ "type":"string", "description":"A detailed description of an error." }, "action":{ "type":"string", "description":"An action that should be taken to recover from the error." }, "violations":{ "type":"array", "description":"List of violations that caused the error.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } }, "resources":{ "type":"array", "description":"List of available resources to recover from the error.", "items":{ "$ref":"#/components/schemas/ApiErrorResource" } } }, "required":[ "action", "description", "errorCode", "resources", "violations" ], "title":"ApiError" }, "ApiErrorResource":{ "type":"object", "description":"List of available resources to recover from the error.", "properties":{ "name":{ "type":"string", "description":"Resource name." }, "url":{ "type":"string", "description":"Resource URL." } }, "title":"ApiErrorResource" }, "ApiErrorViolation":{ "type":"object", "description":"List of violations that caused the error.", "properties":{ "property":{ "type":"string", "description":"Request property that caused the error." }, "violation":{ "type":"string", "description":"Detailed violation description." } }, "title":"ApiErrorViolation" } }, "responses":{ "ApiError400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E400\n Request cannot be processed.\n Check the syntax, violations and adjust the request.\n \n \n\n" } } }, "ApiError401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E401", "description":"The request lacks valid authentication credentials for the requested resource.", "action":"Check the resources and adjust authentication credentials.", "violations":[], "resources":[ { "name":"API Authentication", "url":"https://www.infobip.com/docs/essentials/api-authentication" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n" } } }, "ApiError403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E403", "description":"Insufficient permissions to access the requested resource.", "action":"Repeat the request with new or different credentials.", "violations":[], "resources":[ { "name":"API Scopes", "url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n" } } }, "ApiError404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E404", "description":"Not found - request URL doesn't exist on the API server or resource is not found.", "action":"Check the resources and adjust your request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E404\n Not found - request URL doesn't exist on the API server or resource is not found.\n Check the resources and adjust your request.\n \n \n\n" } } }, "ApiError429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E429", "description":"Too many requests sent.", "action":"Check request rate limit specified in the API endpoint documentation resource.", "violations":[], "resources":[ { "name":"Throttling handling errors", "url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n" } } }, "ApiError500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E500", "description":"Something went wrong.", "action":"Contact the support.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n" } } } }, "parameters":{}, "examples":{}, "requestBodies":{}, "headers":{}, "securitySchemes":{ "APIKeyHeader":{ "type":"apiKey", "description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n", "name":"Authorization", "in":"header" }, "Basic":{ "type":"http", "description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n", "scheme":"basic" }, "IBSSOTokenHeader":{ "type":"apiKey", "description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n", "name":"Authorization", "in":"header" }, "OAuth2":{ "type":"oauth2", "description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```", "flows":{ "clientCredentials":{ "tokenUrl":"https://api.infobip.com/auth/1/oauth2/token", "scopes":{} } } } }, "links":{}, "callbacks":{} } }