Clients

Creates a new client with the specified configuration, including feature flags, language settings, and branding options. Returns the full client object upon success

Creates a new client with the specified configuration, including feature flags, language settings, and branding options. Returns the full client object upon success.

POSThttps://example.thoughtindustries.com/incoming/v2/clients

Example request

curl -X POST "https://example.thoughtindustries.com/incoming/v2/clients" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "slug": "string",
  "enableSegmentation": true,
  "enableDiscussions": true
}'

Parameters

Name	Type	Required	Location	Description
`name`	`string`	Yes	body	Display name for the client.
`slug`	`string`	Yes	body	URL-safe identifier for the client.
`enableSegmentation`	`boolean`	Yes	body	Enables learner segmentation for this client.
`enableDiscussions`	`boolean`	No	body	Enables discussion forums across the client's courses.
`enableCommunitiesSegmentation`	`boolean`	No	body	Enables segmentation within communities features.
`enableEcommerce`	`boolean`	Yes	body	Enables e-commerce purchasing for this client.
`enableRecommendationAssessment`	`boolean`	No	body	Enables the recommendation assessment feature for this client.
`enableBranding`	`boolean`	Yes	body	Enables custom branding for this client.
`enableOnboardingSurvey`	`boolean`	Yes	body	Enables the onboarding survey presented to new learners.
`enableGlobalLinks`	`boolean`	Yes	body	Enables global navigation links in the client interface.
`enableNavLinks`	`boolean`	Yes	body	Enables the navigation link bar in the client interface.
`enableContentDetailPage`	`boolean`	No	body	Enables dedicated detail pages for content items.
`enableLicenseDashboards`	`boolean`	No	body	Enables license-specific dashboard views.
`enableCreditPurchasing`	`boolean`	No	body	Enables learners to purchase credits within this client.
`defaultLanguage`	`string`	No	body	Default language for the client interface as a BCP 47 language tag (e.g., `en`).
`languageSelectorEnabled`	`boolean`	No	body	Enables the language selector in the client interface.
`autoFilterForSelectedLanguage`	`boolean`	No	body	Automatically filters catalog content to match the learner's selected language.
`languages`	`string[]`	Yes	body	List of BCP 47 language tags supported by this client (e.g., `["en", "fr"]`).

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "slug": "string",
  "enableSegmentation": true,
  "enableDiscussions": true,
  "enableCommunitiesSegmentation": true,
  "enableEcommerce": true,
  "enableBranding": true,
  "enableOnboardingSurvey": true,
  "enableRecommendationAssessment": true,
  "enableNavLinks": true,
  "enableContentDetailPage": true,
  "enableLicenseDashboards": true,
  "defaultLanguage": "string",
  "languageSelectorEnabled": true,
  "languages": [
    "string"
  ],
  "autoFilterForSelectedLanguage": true,
  "enableCreditPurchasing": true,
  "startingBalance": 0,
  "currentBalance": 0
}

Response fields

Field	Type	Description
`id`	`uuid`	Identifier of the created client.
`name`	`string`	Name of the client.
`slug`	`string`	URL slug of the client.
`enableSegmentation`	`boolean`	Whether segmentation is enabled.
`enableDiscussions`	`boolean`	Whether discussions are enabled.
`enableCommunitiesSegmentation`	`boolean`	Whether communities segmentation is enabled.
`enableEcommerce`	`boolean`	Whether ecommerce is enabled.
`enableBranding`	`boolean`	Whether custom branding is enabled.
`enableOnboardingSurvey`	`boolean`	Whether the onboarding survey is enabled.
`enableRecommendationAssessment`	`boolean`	Whether the recommendation assessment is enabled.
`enableNavLinks`	`boolean`	Whether navigation links are enabled.
`enableContentDetailPage`	`boolean`	Whether the content detail page is enabled.
`enableLicenseDashboards`	`boolean`	Whether license dashboards are enabled.
`defaultLanguage`	`string`	Default language for the client.
`languageSelectorEnabled`	`boolean`	Whether the language selector is enabled.
`languages`	`string[]`	Languages configured for the client.
`autoFilterForSelectedLanguage`	`boolean`	Whether content auto-filters by selected language.
`enableCreditPurchasing`	`boolean`	Whether credit purchasing is enabled.
`startingBalance`	`number`	Starting credit balance.
`currentBalance`	`number`	Current credit balance.