Bulk Import Webinar
Bulk-imports webinar sessions from an asset file. Submit the path to a structured import asset, and the API validates each row, returning valid and invalid entries along with a background job that tracks the import's progress
Bulk-imports webinar sessions from an asset file. Submit the path to a structured import asset, and the API validates each row, returning valid and invalid entries along with a background job that tracks the import's progress.
POST
https://example.thoughtindustries.com/incoming/v2/content/session/webinar/bulkExample request
curl -X POST "https://example.thoughtindustries.com/incoming/v2/content/session/webinar/bulk" \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"bulkImportAssetPath": "string"
}'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
bulkImportAssetPath | string | Yes | body | The storage path to the asset file containing the webinar session rows to import. |
Example response
{
"data": {
"APIBulkWebinarImport": {
"dryRun": true,
"validRows": [
{}
],
"invalidRows": [
{}
],
"backgroundJob": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "string",
"description": "string",
"errorMessage": "string",
"createdAt": "2024-01-01T00:00:00.000Z",
"repeatable": true,
"status": "complete"
}
}
}
}Response fields
| Field | Type | Description |
|---|---|---|
dryRun | boolean | Indicates whether the import was executed as a dry run without persisting data. |
validRows | object[] | Array of row objects that passed validation and are eligible for import. |
invalidRows | object[] | Array of row objects that failed validation and were not imported. |
backgroundJob | BackgroundJob | The background job created to process the import asynchronously. |
backgroundJob.id | uuid | Unique identifier of the background job. |
backgroundJob.type | string | The job type, indicating the category of work being performed. |
backgroundJob.description | string | Human-readable description of the background job. |
backgroundJob.errorMessage | string | Error message populated if the background job fails. |
backgroundJob.createdAt | ISO 8601 timestamp | The date and time the background job was created, in ISO 8601 format. |
backgroundJob.repeatable | boolean | Indicates whether the background job is configured to run repeatedly. |
backgroundJob.status | BackgroundJobStatus | Current status of the background job (e.g., complete). |