Import to existing project

Import to existing project

Imports content into an existing project from multiple supported formats.

Path Parameters
  • project-id
    string
    required

    The ID of the project to import into.

Query Parameters
  • format
    string enum
    required

    Specifies how the import data is provided. Can be url or base64.

    • url
    • base64
Body
application/json
importFormat
string enum

Import format.

  • Word
  • Rtf
  • Epub
  • Odt
  • Html
  • Markdown
  • ProjectBackup
  • Docfx
  • AutoDocs
inputFileContent
string

Base64-encoded content of the file to import. Required if base64 is selected for the format query parameter. If url format is selected, this parameter is ignored.

inputFileName
string

The name of the file with an extension. Required if base64 is selected for the format query parameter. If url format is selected, this parameter is ignored.

inputFileUrl
string

The URL of the file. It can be a public URL (no authentication required) or a path to a file in ClickHelp Storage. Required if url is selected for the format query parameter. If base64 format is selected, this parameter is ignored.

newProjectId
string

The ID of a new project where to import a definition. Either newProjectId or newProjectName should be specified.

newProjectName
string

The name of a new project where to import a definition. Either newProjectId or newProjectName should be specified.

newProjectLanguageFourLetterCode
string

An ISO 639 four-letter language code of a new project where to import a definition. If not specified, the en-US code is used.

options
object

Additional import parameters.

Responses
POST/projects/{project-id}/import


{
  "taskKey": "f8de60eb4ad8757c5a2b533afae6251aa"
}

OK