KnowledgeBase

/knowledgebase/articles/draft

Changed on

Create a new article draft in knowledgebase

post/knowledgebase/articles/draft

Request

  • Base URL
    <<api-url>> (relative, and the document’s source URL is not known)
  • Auth
    API key in header X-API-KEY

Headers

octa-agent-emailstring

Request body

culturestring

Culture/Language code

titlestring required

Article title

subtitlestring

Article subtitle

urlstring required

Article URL (relative path)

contentstring required

Article content in HTML format

snippetstring

Article snippet/summary

status'Unpublished' | 'PublishedWithChanges' | 'Published' | 'Draft' | 'Empty' required

Article status (will be forced to Draft)

moduleIdstring required

Knowledgebase Module ID

mainSectionstring required

Main section ID

orderIdnumber

Article order ID

categoryIdsstring[] required

Category IDs

sectionIdsstring[] required

Section IDs

idstring

Article ID (use 00000000-0000-0000-0000-000000000000 for new articles)

articleIdstring

Article ID (use 00000000-0000-0000-0000-000000000000 for new articles)

plainTextstring

Article plain text content

Response

culturestring

Culture/Language code

titlestring required

Article title

subtitlestring

Article subtitle

urlstring required

Article URL (relative path)

contentstring required

Article content in HTML format

snippetstring

Article snippet/summary

status'Unpublished' | 'PublishedWithChanges' | 'Published' | 'Draft' | 'Empty' required

Article status (will be forced to Draft)

moduleIdstring required

Knowledgebase Module ID

mainSectionstring required

Main section ID

orderIdnumber

Article order ID

categoryIdsstring[] required

Category IDs

sectionIdsstring[] required

Section IDs

idstring required

Article ID

articleIdstring required

Article ID

plainTextstring required

Article plain text content

Changes