Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
contentManagement

Start a content import job.

Schedule an asynchronous import of content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the overwrite parameter to true to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less.

post/v2/content/folders/{folderId}/import

Path parameters

folderIdstring required

The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.

Query parameters

overwriteboolean

Set this to "true" to overwrite a content item if the name already exists.

Headers

isAdminModestring

Set this to "true" if you want to perform the request as a Content Administrator.

Request body

typestring required

The content item type. Note:

  • MewboardSyncDefinition is depreciated, and will soon be removed. Please use DashboardV2SyncDefinition instead.
  • Dashboard links are not supported for dashboards.
namestring required

The name of the item.

Response

Import job has been scheduled.

idstring required

Identifier to get the status of an asynchronous job.

Example response

{
  "id": "C03E086C137F38B4"
}