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[]`	No	body	IDs of the bundles to enroll imported users in.
`courseIds`	`uuid[]`	No	body	IDs of the courses to enroll imported users in.
`learningPathIds`	`uuid[]`	No	body	IDs of the learning paths to enroll imported users in.
`licenseIds`	`uuid[]`	No	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

{
  "id": "00000000-0000-0000-0000-000000000000",
  "description": "string",
  "errorMessage": "string",
  "status": "string"
}

Response fields

Field	Type	Description
`id`	`uuid`	Identifier of the background job processing the import.
`description`	`string`	Human-readable description of the job.
`errorMessage`	`string`	Error message if the job failed to start or run.
`status`	`string`	Current status of the background job.