Bulk Content Remove Access

Removes content access from multiple users in a single request

Removes content access from multiple users in a single request.

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

Example request — remove a course by user ID

curl -X POST "https://example.thoughtindustries.com/incoming/v2/users/bulkContentRemoveAccess" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "users": [
    {
      "id": "3f9a2b18-7c4d-4e2a-9b1f-0c5d6e7f8a90",
      "courseIds": ["8f2a1c34-5b6d-4e7f-9a01-2b3c4d5e6f70"]
    }
  ]
}'

Example request — remove courses and learning paths by email

curl -X POST "https://example.thoughtindustries.com/incoming/v2/users/bulkContentRemoveAccess" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "users": [
    {
      "email": "[email protected]",
      "courseIds": ["8f2a1c34-5b6d-4e7f-9a01-2b3c4d5e6f70"],
      "learningPathIds": ["1d9e8f70-4a3b-4c2d-8e1f-0a9b8c7d6e5f"]
    }
  ]
}'

Example request — bulk remove for multiple users (mixed identifiers)

curl -X POST "https://example.thoughtindustries.com/incoming/v2/users/bulkContentRemoveAccess" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "users": [
    {
      "id": "3f9a2b18-7c4d-4e2a-9b1f-0c5d6e7f8a90",
      "courseIds": ["8f2a1c34-5b6d-4e7f-9a01-2b3c4d5e6f70"]
    },
    {
      "externalCustomerId": "CRM-88213",
      "learningPathIds": ["1d9e8f70-4a3b-4c2d-8e1f-0a9b8c7d6e5f"]
    }
  ]
}'

Parameters

Requires the users.edit permission.

Name	Type	Required	Location	Description
`users`	`BulkContentRemoveAccessUser[]`	Yes	body	Array of user–content objects specifying whose access to remove (see below).

Each object in users (BulkContentRemoveAccessUser):

Field	Type	Required	Description
`id`	`uuid`	One of `id` / `email` / `externalCustomerId`	ID of the user to remove access from.
`email`	`string`	One of `id` / `email` / `externalCustomerId`	Email of the user to remove access from.
`externalCustomerId`	`string`	One of `id` / `email` / `externalCustomerId`	External customer ID of the user to remove access from.
`courseIds`	`uuid[]`	No	Course UUIDs to remove the user's access to.
`learningPathIds`	`uuid[]`	No	Learning path UUIDs to remove the user's access to.

Example response

{
  "updatedRecordCount": 0,
  "errors": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "identifier": "string",
      "error": "string",
      "record": "string"
    }
  ]
}

Response fields

Field	Type	Description
`updatedRecordCount`	`integer`	Number of records successfully updated.
`errors`	`object[]`	Per-record errors for entries that could not be processed.
`errors.id`	`uuid`	Identifier associated with the failed record, when resolvable.
`errors.identifier`	`string`	The identifier value from the input record.
`errors.error`	`string`	Human-readable message describing why the record failed.
`errors.record`	`string`	Raw input record associated with the failure.