Update Access

Updates the content access settings for a client, including the courses, learning paths, course tags, and purchasable content the client can access. Returns the updated client object

Updates the content access settings for a client, including the courses, learning paths, course tags, and purchasable content the client can access. Returns the updated client object.

PUThttps://example.thoughtindustries.com/incoming/v2/clients/:id/updateAccess

Example request

curl -X PUT "https://example.thoughtindustries.com/incoming/v2/clients/:id/updateAccess" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "courseIds": "00000000-0000-0000-0000-000000000000",
  "courseTagIds": "00000000-0000-0000-0000-000000000000",
  "learningPathIds": "00000000-0000-0000-0000-000000000000",
  "purchasableContentIds": "00000000-0000-0000-0000-000000000000"
}'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	The id identifier.
`courseIds`	`uuid[]`	Yes	body	IDs of the courses to grant the client access to.
`courseTagIds`	`uuid[]`	Yes	body	IDs of the course tags used to grant the client access to all courses with matching tags.
`learningPathIds`	`uuid[]`	Yes	body	IDs of the learning paths to grant the client access to.
`purchasableContentIds`	`uuid[]`	Yes	body	IDs of the purchasable content items to grant the client access to.
`purchasableTagIds`	`uuid[]`	Yes	body	IDs of the purchasable content tags used to grant the client access to all matching purchasable items.
`replaceCourseIds`	`boolean`	No	body	When `true`, replaces the client's existing course access list with the provided `courseIds` instead of appending to it.
`replaceLearningPathIds`	`boolean`	No	body	When `true`, replaces the client's existing learning path access list with the provided `learningPathIds` instead of appending to it.
`replaceCourseTagIds`	`boolean`	No	body	When `true`, replaces the client's existing course tag access list with the provided `courseTagIds` instead of appending to it.
`replacePurchasableContentIds`	`boolean`	No	body	When `true`, replaces the client's existing purchasable content access list with the provided `purchasableContentIds` instead of appending to it.
`replacePurchasableTagIds`	`boolean`	No	body	When `true`, replaces the client's existing purchasable tag access list with the provided `purchasableTagIds` instead of appending to it.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "courseTagIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "courseIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "learningPathIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "purchasableContentIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "purchasableTagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Response fields

Field	Type	Description
`id`	`uuid`	Identifier of the client.
`courseTagIds`	`uuid[]`	Identifiers of course tags the client can access.
`courseIds`	`uuid[]`	Identifiers of courses the client can access.
`learningPathIds`	`uuid[]`	Identifiers of learning paths the client can access.
`purchasableContentIds`	`uuid[]`	Identifiers of content the client can purchase.
`purchasableTagIds`	`uuid[]`	Identifiers of tags the client can purchase.