Bulk Import Course Group In Person Event

Bulk-imports in-person events for course groups from a pre-uploaded asset file. Submit the asset path to validate and process the import, optionally as a dry run

Bulk-imports in-person events for course groups from a pre-uploaded asset file. Submit the asset path to validate and process the import, optionally as a dry run.

POSThttps://example.thoughtindustries.com/incoming/v2/content/courseGroup/inPersonEvent/bulk

Example request

curl -X POST "https://example.thoughtindustries.com/incoming/v2/content/courseGroup/inPersonEvent/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 file path of the pre-uploaded asset containing the in-person event records to import.

Example response

{
  "data": {
    "APIBulkCourseGroupInPersonEventImport": {
      "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 changes.
`validRows`	`object[]`	Array of rows from the import file that passed validation.
`invalidRows`	`object[]`	Array of rows from the import file that failed validation.
`backgroundJob`	`BackgroundJob`	The background job created to process the bulk import.
`backgroundJob.id`	`uuid`	Unique identifier of the background job.
`backgroundJob.type`	`string`	The type classification of the background job.
`backgroundJob.description`	`string`	Human-readable description of the background job.
`backgroundJob.errorMessage`	`string`	Error message returned if the background job failed.
`backgroundJob.createdAt`	`ISO 8601 timestamp`	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`).