HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request to set the tenant configuration.

PUT {TenantURL}/configuration

You can use the standard HTTP If-Unmodified-Since request header to help prevent unintended overwrites during concurrent updates. This header enables stale update validation by comparing the client's last-known configuration state with the latest stored configuration state before the update is accepted.

For more information, see Concurrent update validation behavior.

Request headers

The following request headers must be included.

Request body

The request body must contain the tenant business configuration in JSON format.

Example request

PUT {TenantURL}/configuration
Content-Type: application/json
If-Unmodified-Since: Mon, 23 Feb 2026 07:05:48 GMT

{
  "label": "Test Business Model",
  "description": "Test Business Model Configuration",
  "schemaVersion": "1",
  "updatedTime": 1700000000000,
  "entityTypes": [
    {
      "URI": "configuration/entityTypes/Individual",
      "label": "Individual",
      "name": "Individual",
      "description": "Represents people",
      "attributes": [
        {
          "URI": "configuration/entityTypes/Individual/attributes/FirstName",
          "name": "FirstName",
          "label": "First Name",
          "type": "String"
        }
      ]
    }
  ]
}

Response body

The response returns the saved tenant business configuration in JSON format. It includes the persisted configuration values and generated id values for configured objects.

Response always includes an id property for elements in collections. These id values help identify differences between schema versions, including added, removed, and modified elements.

Example response

{
  "label": "Test Business Model",
  "description": "Test Business Model Configuration",
  "schemaVersion": "1",
  "updatedTime": 1700000005000,
  "entityTypes": [
    {
      "URI": "configuration/entityTypes/Individual",
      "label": "Individual",
      "name": "Individual",
      "id": "1",
      "description": "Represents people",
      "attributes": [
        {
          "URI": "configuration/entityTypes/Individual/attributes/FirstName",
          "name": "FirstName",
          "label": "First Name",
          "id": "2",
          "type": "String"
        }
      ]
    }
  ]
}

Concurrent update validation behavior

When multiple users or systems update the tenant business configuration at the same time, a stale update can overwrite newer changes. To prevent stale overwrites, the PUT /configuration endpoint supports concurrent update validation through the standard HTTP If-Unmodified-Since request header.

When the header is present, the system compares its value with the latest stored updatedTime for the configuration.

• If no business model exists, the request is treated as a first-time save and is accepted.
• If the client does not send the If-Unmodified-Since header, the system skips validation and processes the update as usual. In that case, the request can overwrite more recent configuration changes.
• If the If-Unmodified-Since header value is greater than or equal to the stored updatedTime, the update is accepted.
• If the If-Unmodified-Since header value is earlier than the stored updatedTime, the update is rejected with HTTP 412 Precondition Failed.

After each successful update, the system assigns a new updatedTime to reflect the latest configuration state.

Errors