For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tenants

Returns information about the specified tenant

get
Path parameters
tenantVarCodestringRequired

Tenant Var Code

Responses
200

OK

TenantCodestring · nullableOptional

Tenant Var Code

Descriptionstring · min: 1Required

Name used to describe the tenant (max 250 characters)

AdminContactsstring · nullableOptional

A semicolon separated list of email addresses

SalesContactsstring · nullableOptional

A semicolon separated list of email addresses

DeviceTypesstring · nullableOptional

A comma separated list of device types that this tenant can provision and manage

CultureNamestring · nullableOptional

The culture used by this tenant. This is normally used in a portal for date formatting

DefaultUiLanguagestring · nullableOptional

The default UI language for new users. Empty value would set user preferences to use browser language settings

TimeZoneIdstring · nullableOptional

The default time zone to be used by this tenant. This is normally used to format dates and times for UI purposes. All dates are stored as UTC

ParentTenantCodestring · nullableOptional

A 4 digit number that uniquely identifies the parent of this tenant, returned only when the user has access to the parent tenant

Timestampstring · date-time · nullableOptional

Timestamp (UTC) indicating version of record being returned

ETagstring · nullableOptional

ETag representing record version

get/V2/{tenantVarCode}
GET /V2/{tenantVarCode} HTTP/1.1
Accept: */*
200

OK

{
  "TenantCode": "text",
  "Description": "text",
  "AdminContacts": "text",
  "SalesContacts": "text",
  "DeviceTypes": "text",
  "CultureName": "text",
  "DefaultUiLanguage": "text",
  "TimeZoneId": "text",
  "Properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "ParentTenantCode": "text",
  "Timestamp": "2026-01-01T00:00:00.000Z",
  "ETag": "text"
}

Creates a new tenant

post
Path parameters
tenantVarCodestringRequired

Parent Tenant Var Code

Body
TenantCodestring · nullableOptional

Tenant Var Code

Descriptionstring · min: 1Required

Name used to describe the tenant (max 250 characters)

AdminContactsstring · nullableOptional

A semicolon separated list of email addresses

SalesContactsstring · nullableOptional

A semicolon separated list of email addresses

DeviceTypesstring · nullableOptional

A comma separated list of device types that this tenant can provision and manage

CultureNamestring · nullableOptional

The culture used by this tenant. This is normally used in a portal for date formatting

DefaultUiLanguagestring · nullableOptional

The default UI language for new users. Empty value would set user preferences to use browser language settings

TimeZoneIdstring · nullableOptional

The default time zone to be used by this tenant. This is normally used to format dates and times for UI purposes. All dates are stored as UTC

ParentTenantCodestring · nullableOptional

A 4 digit number that uniquely identifies the parent of this tenant, returned only when the user has access to the parent tenant

Timestampstring · date-time · nullableOptional

Timestamp (UTC) indicating version of record being returned

ETagstring · nullableOptional

ETag representing record version

Responses
200

OK

TenantCodestring · nullableOptional

Tenant Var Code

Descriptionstring · min: 1Required

Name used to describe the tenant (max 250 characters)

AdminContactsstring · nullableOptional

A semicolon separated list of email addresses

SalesContactsstring · nullableOptional

A semicolon separated list of email addresses

DeviceTypesstring · nullableOptional

A comma separated list of device types that this tenant can provision and manage

CultureNamestring · nullableOptional

The culture used by this tenant. This is normally used in a portal for date formatting

DefaultUiLanguagestring · nullableOptional

The default UI language for new users. Empty value would set user preferences to use browser language settings

TimeZoneIdstring · nullableOptional

The default time zone to be used by this tenant. This is normally used to format dates and times for UI purposes. All dates are stored as UTC

ParentTenantCodestring · nullableOptional

A 4 digit number that uniquely identifies the parent of this tenant, returned only when the user has access to the parent tenant

Timestampstring · date-time · nullableOptional

Timestamp (UTC) indicating version of record being returned

ETagstring · nullableOptional

ETag representing record version

post/V2/{tenantVarCode}
POST /V2/{tenantVarCode} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "TenantCode": "text",
  "Description": "text",
  "AdminContacts": "text",
  "SalesContacts": "text",
  "DeviceTypes": "text",
  "CultureName": "text",
  "DefaultUiLanguage": "text",
  "TimeZoneId": "text",
  "Properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "ParentTenantCode": "text",
  "Timestamp": "2026-01-01T00:00:00.000Z",
  "ETag": "text"
}
200

OK

{
  "TenantCode": "text",
  "Description": "text",
  "AdminContacts": "text",
  "SalesContacts": "text",
  "DeviceTypes": "text",
  "CultureName": "text",
  "DefaultUiLanguage": "text",
  "TimeZoneId": "text",
  "Properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "ParentTenantCode": "text",
  "Timestamp": "2026-01-01T00:00:00.000Z",
  "ETag": "text"
}

Updates an existing tenant

put
Path parameters
tenantVarCodestringRequired

Tenant Var Code

Body
TenantCodestring · nullableOptional

Tenant Var Code

Descriptionstring · min: 1Required

Name used to describe the tenant (max 250 characters)

AdminContactsstring · nullableOptional

A semicolon separated list of email addresses

SalesContactsstring · nullableOptional

A semicolon separated list of email addresses

DeviceTypesstring · nullableOptional

A comma separated list of device types that this tenant can provision and manage

CultureNamestring · nullableOptional

The culture used by this tenant. This is normally used in a portal for date formatting

DefaultUiLanguagestring · nullableOptional

The default UI language for new users. Empty value would set user preferences to use browser language settings

TimeZoneIdstring · nullableOptional

The default time zone to be used by this tenant. This is normally used to format dates and times for UI purposes. All dates are stored as UTC

ParentTenantCodestring · nullableOptional

A 4 digit number that uniquely identifies the parent of this tenant, returned only when the user has access to the parent tenant

Timestampstring · date-time · nullableOptional

Timestamp (UTC) indicating version of record being returned

ETagstring · nullableOptional

ETag representing record version

Responses
200

OK

No content

put/V2/{tenantVarCode}
PUT /V2/{tenantVarCode} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "TenantCode": "text",
  "Description": "text",
  "AdminContacts": "text",
  "SalesContacts": "text",
  "DeviceTypes": "text",
  "CultureName": "text",
  "DefaultUiLanguage": "text",
  "TimeZoneId": "text",
  "Properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "ParentTenantCode": "text",
  "Timestamp": "2026-01-01T00:00:00.000Z",
  "ETag": "text"
}
200

OK

No content

Deletes a tenant

delete
Path parameters
tenantVarCodestringRequired

Tenant Var Code

Responses
200

OK

No content

delete/V2/{tenantVarCode}
DELETE /V2/{tenantVarCode} HTTP/1.1
Accept: */*
200

OK

No content

Returns subtenants for specified tenant

get
Path parameters
tenantVarCodestringRequired

Tenant Var Code

Responses
200

OK

TenantCodestring · nullableOptional

Tenant Var Code

Descriptionstring · min: 1Required

Name used to describe the tenant (max 250 characters)

AdminContactsstring · nullableOptional

A semicolon separated list of email addresses

SalesContactsstring · nullableOptional

A semicolon separated list of email addresses

DeviceTypesstring · nullableOptional

A comma separated list of device types that this tenant can provision and manage

CultureNamestring · nullableOptional

The culture used by this tenant. This is normally used in a portal for date formatting

DefaultUiLanguagestring · nullableOptional

The default UI language for new users. Empty value would set user preferences to use browser language settings

TimeZoneIdstring · nullableOptional

The default time zone to be used by this tenant. This is normally used to format dates and times for UI purposes. All dates are stored as UTC

ParentTenantCodestring · nullableOptional

A 4 digit number that uniquely identifies the parent of this tenant, returned only when the user has access to the parent tenant

Timestampstring · date-time · nullableOptional

Timestamp (UTC) indicating version of record being returned

ETagstring · nullableOptional

ETag representing record version

get/V2/{tenantVarCode}/tenants
GET /V2/{tenantVarCode}/tenants HTTP/1.1
Accept: */*
200

OK

[
  {
    "TenantCode": "text",
    "Description": "text",
    "AdminContacts": "text",
    "SalesContacts": "text",
    "DeviceTypes": "text",
    "CultureName": "text",
    "DefaultUiLanguage": "text",
    "TimeZoneId": "text",
    "Properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "ParentTenantCode": "text",
    "Timestamp": "2026-01-01T00:00:00.000Z",
    "ETag": "text"
  }
]

Last updated