Update Settings
Updates configuration settings for the specified client, including feature flags, localization options, seat limits, and licensing
Updates configuration settings for the specified client, including feature flags, localization options, seat limits, and licensing.
PUT
https://example.thoughtindustries.com/incoming/v2/clients/:id/updateSettingsExample request
curl -X PUT "https://example.thoughtindustries.com/incoming/v2/clients/:id/updateSettings" \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"slug": "string",
"seatsLimit": 0,
"sku": "string"
}'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
id | uuid | Yes | path | The id identifier. |
name | string | Yes | body | Display name of the client. |
slug | string | No | body | URL-safe identifier for the client. |
seatsLimit | integer | No | body | Maximum number of seats available for the client; 0 indicates no limit. |
sku | string | No | body | Stock-keeping unit identifier for the client. |
tagIds | uuid[] | Yes | body | IDs of the tags to associate with the client. |
notificationEmails | string | No | body | Comma-separated email addresses that receive client notifications. |
licenseEndDate | ISO 8601 timestamp | No | body | Date and time when the client's license expires, as an ISO 8601 timestamp. |
enableSegmentation | boolean | Yes | body | When true, enables audience segmentation for the client. |
enableDiscussions | boolean | No | body | When true, enables discussion features across the client's content. |
enableCommunitiesSegmentation | boolean | No | body | When true, enables segmentation within communities. |
enableRecommendationAssessment | boolean | No | body | When true, enables the recommendation assessment feature. |
enableEcommerce | boolean | Yes | body | When true, enables e-commerce purchasing for the client. |
enableBranding | boolean | Yes | body | When true, enables custom branding for the client. |
enableOnboardingSurvey | boolean | Yes | body | When true, displays the onboarding survey to new learners. |
enableGlobalLinks | boolean | Yes | body | When true, enables global navigation links in the client interface. |
enableNavLinks | boolean | Yes | body | When true, enables navigation links in the client interface. |
defaultLanguage | string | No | body | BCP 47 language code for the client's default display language. |
languages | string[] | Yes | body | List of BCP 47 language codes supported by the client. |
languageSelectorEnabled | boolean | No | body | When true, shows a language selector to learners. |
autoFilterForSelectedLanguage | boolean | No | body | When true, automatically filters content to match the learner's selected language. |
enableContentDetailPage | boolean | No | body | When true, enables dedicated detail pages for content items. |
enableLicenseDashboards | boolean | No | body | When true, enables license-level dashboards for managers. |
enableCreditPurchasing | boolean | No | body | When true, allows learners to purchase credits within the client. |
enableCustomEmailSettings | boolean | No | body | When true, enables custom email sender settings for the client. |
Example response
{
"data": {
"UpdateClientSettings": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"schoolName": "string",
"courses": [
{
"id": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"slug": "example-slug",
"status": "draft",
"title": "string",
"sessionIsTitled": true,
"sampleLesson": {
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"slug": "example-slug",
"accessLevel": "studentsOnly",
"section": {
"...": "..."
},
"slugOrId": "string",
"topics": [
null
],
"topicOutline": [
{
"...": "..."
}
]
},
"sampleLessonId": "00000000-0000-0000-0000-000000000000",
"sections": [
{
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"lessons": [
{
"...": "..."
}
],
"slug": "example-slug",
"status": "draft",
"releaseAt": "2024-01-01T00:00:00.000Z",
"parentSectionId": "00000000-0000-0000-0000-000000000000"
}
],
"appearanceBlock": "00000000-0000-0000-0000-000000000000",
"appearanceHash": "string",
"paywallsBlock": "00000000-0000-0000-0000-000000000000",
"termsBlock": "00000000-0000-0000-0000-000000000000",
"confirmationBlock": "00000000-0000-0000-0000-000000000000",
"courseStartDate": "2024-01-01T00:00:00.000Z",
"courseEndDate": "2024-01-01T00:00:00.000Z",
"enrollmentStartDate": "2024-01-01T00:00:00.000Z",
"enrollmentEndDate": "2024-01-01T00:00:00.000Z",
"gracePeriodEndDate": "2024-01-01T00:00:00.000Z",
"seatsLimit": 0,
"waitlistCount": 0,
"seatsLimitMet": true,
"waitlistingEnabled": true,
"waitlistingTriggered": true,
"taxable": true,
"purchasable": true,
"taxCategory": "00000000-0000-0000-0000-000000000000",
"fulfillmentCenter": "00000000-0000-0000-0000-000000000000",
"courseGroup": {
"id": "00000000-0000-0000-0000-000000000000",
"authoringClientId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"displayCourse": {
"...": "..."
},
"displayBundle": {
"...": "..."
},
"courses": [
{
"...": "..."
}
],
"asset": "string",
"assetAltText": "string",
"assetLibraryId": "00000000-0000-0000-0000-000000000000",
"detailAsset": "string",
"detailAssetAltText": "string",
"detailAssetLibraryId": "00000000-0000-0000-0000-000000000000",
"videoAsset": "string",
"tabs": [
{
"...": "..."
}
],
"description": "string",
"title": "string",
"archived": true,
"metaTitle": "string",
"metaDescription": "string",
"language": "string",
"slug": "example-slug",
"rating": 0,
"ratingsCount": 0,
"relatedCourseGroups": [
{
"...": "..."
}
],
"relatedQuery": "string",
"relatedQuerySort": "string",
"relatedQueryLimit": 0,
"relatedQuerySignature": "string",
"relatedShowImageAsset": true,
"relatedShowDescription": true,
"externalPurchaseUrl": "string",
"externalDetailUrl": "string",
"layout": {
"...": "..."
},
"hasParentCourseGroup": true,
"tags": [
{
"...": "..."
}
],
"customFields": {},
"authors": [
"string"
],
"source": "string",
"isbn": "string",
"ribbon": "example-slug",
"contentType": {
"...": "..."
},
"kind": "microCourse",
"availabilityStatus": "string",
"ownedByActiveScope": true,
"allowRescheduling": true,
"currentUserMayReschedule": true,
"isTemplate": true
},
"syllabusTitlesEnabled": true,
"galleryEnabled": true,
"workbookEnabled": true,
"linkedWorkbookEnabled": true,
"linkedWorkbookSkipEnabled": true,
"superquizEnabled": true,
"discussionsEnabled": true,
"resourcesEnabled": true,
"meetingsOverviewEnabled": true,
"recurrenceRule": "string",
"recurrence": {},
"readableRecurrenceString": "string",
"instructorAccessEnabled": true,
"instructorEmails": [
"string"
],
"freeWithRegistration": true,
"priceInCents": 0,
"instructorAccessPriceInCents": 0,
"suggestedRetailPriceInCents": 0,
"alternativePricingType": "membership",
"alternativePricingRef": 0,
"accessDays": 0,
"showProgress": true,
"annotationsEnabled": true,
"forceLinearProgress": true,
"completionTimePerPage": 0,
"askLearnerPassword": true,
"roster": true,
"topicGroupId": "00000000-0000-0000-0000-000000000000",
"sku": "string",
"prerequisiteCourses": [
{
"...": "..."
}
],
"prerequisiteLearningPaths": [
{
"id": "00000000-0000-0000-0000-000000000000",
"layoutId": "00000000-0000-0000-0000-000000000000",
"layout": {
"...": "..."
},
"learnerLayoutId": "00000000-0000-0000-0000-000000000000",
"learnerLayout": {
"...": "..."
},
"name": "string",
"sku": "string",
"ribbon": {
"...": "..."
},
"slug": "example-slug",
"client": {
"...": "..."
},
"createdAt": "2024-01-01T00:00:00.000Z",
"metaTitle": "string",
"metaDescription": "string",
"asset": "https://example.com/path",
"assetAltText": "string",
"assetLibraryId": "00000000-0000-0000-0000-000000000000",
"detailAsset": "https://example.com/path",
"detailAssetAltText": "string",
"detailAssetLibraryId": "00000000-0000-0000-0000-000000000000",
"heroAsset": "https://example.com/path",
"heroAssetAltText": "string",
"priceInCents": 0,
"suggestedRetailPriceInCents": 0,
"alternativePricingType": "membership",
"alternativePricingRef": 0,
"accessDays": 0,
"shortDescription": "string",
"longDescription": "string",
"tags": [
{
"...": "..."
}
],
"status": "draft",
"freeWithRegistration": true,
"hasMultipleCurrencies": true,
"prices": [
{
"...": "..."
}
],
"customFields": {},
"contentType": "string",
"confirmationHtml": "string",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-01T00:00:00.000Z",
"enrollmentStartDate": "2024-01-01T00:00:00.000Z",
"enrollmentEndDate": "2024-01-01T00:00:00.000Z",
"milestones": [
{
"...": "..."
}
],
"availabilityStatus": "string",
"currentUserStartActionDate": "2024-01-01T00:00:00.000Z",
"isPayAsYouGo": true,
"language": "string",
"futurePublishDate": "2024-01-01T00:00:00.000Z",
"purchasable": true,
"taxable": true,
"fulfillmentCenter": {
"...": "..."
},
"taxCategory": "00000000-0000-0000-0000-000000000000",
"currentUserPendingCertificate": true,
"currentUserEarnedCertificate": true,
"currentUserDueDate": "2024-01-01T00:00:00.000Z",
"bulkPurchasingEnabled": true,
"seatTiers": [
{
"...": "..."
}
],
"seatPackages": [
{
"...": "..."
}
],
"lastTierPriceInCents": 0,
"prerequisiteCourses": [
{
"...": "..."
}
],
"prerequisiteLearningPaths": [
{
"...": "..."
}
],
"resourceType": "string",
"seatsLimit": 0,
"videoAsset": "00000000-0000-0000-0000-000000000000",
"relatedQuery": "string",
"relatedQuerySignature": "string",
"source": "string",
"authors": [
"string"
],
"publishDate": "2024-01-01T00:00:00.000Z",
"externalDetailUrl": "string",
"externalConditionalRedirectUrl": "string",
"kind": "string",
"tabs": {
"...": "..."
},
"updatedAt": "2024-01-01T00:00:00.000Z",
"dueDate": "2024-01-01T00:00:00.000Z",
"dueDateDays": 0,
"allowUnorderedMilestoneAccess": true,
"authoringClient": "00000000-0000-0000-0000-000000000000",
"isTemplate": true,
"externalPurchaseUrl": "string"
}
],