Bulk Import

Create bulkImport

POSThttps://example.thoughtindustries.com/incoming/v2/users/bulkImport

Example request

curl -X POST "https://example.thoughtindustries.com/incoming/v2/users/bulkImport" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "string",
  "inviteMessage": "string",
  "bundleIds": "00000000-0000-0000-0000-000000000000",
  "courseIds": "00000000-0000-0000-0000-000000000000"
}'

Parameters

Name	Type	Required	Location	Description
`url`	`string`	Yes	body	URL of the CSV file containing the users to import.
`inviteMessage`	`string`	No	body	Custom message to include in the invitation email sent to imported users.
`bundleIds`	`uuid[]`	Yes	body	IDs of the bundles to enroll imported users in.
`courseIds`	`uuid[]`	Yes	body	IDs of the courses to enroll imported users in.
`learningPathIds`	`uuid[]`	Yes	body	IDs of the learning paths to enroll imported users in.
`licenseIds`	`uuid[]`	Yes	body	IDs of the licenses to assign to imported users.
`clientId`	`uuid`	No	body	ID of the client portal to associate the imported users with.
`role`	`string`	No	body	Role to assign to each imported user within the platform.
`dryRun`	`boolean`	No	body	When `true`, validates the import without creating or modifying any users.

Example response

{
  "data": {
    "APIBulkImport": {
      "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
`id`	`uuid`	Unique identifier of the bulk import background job.
`type`	`string`	Category or kind of background job that was created.
`description`	`string`	Human-readable summary of the background job.
`errorMessage`	`string`	Error detail returned if the import job failed; empty when the job succeeded.
`createdAt`	`ISO 8601 timestamp`	Date and time when the import job was created, in ISO 8601 format.
`repeatable`	`boolean`	Indicates whether the import job can be re-run with the same parameters.
`status`	`BackgroundJobStatus`	Current processing state of the import job (e.g. `complete`).