Help Page Home

# PUT Tenants({id})

Update the details of a tenant.

## Request Information

### Parameters

Name | Description | Additional information
--- | --- | ---
id | ID of the tenant to update. | Type: String
changeId | See Optimistic Concurrency. | Type: String

## Request body type

UpdateTenantModel

### Request body formats

#### application/json, text/json

Sample:

    {
      "Name": "tenant 1",
      "Description": "my first tenant",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "StoreFrontIsolationMode": "PrivateServerGroup",
      "LocationUserGroups": [
        {
          "UserGroupName": "DOMAIN\\tenant1 datacenter1 users",
          "PrimaryDataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
        }
      ],
      "NetScalerGatewayIsolationMode": "Private",
      "TenantDataCenters": [
        {
          "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
          "NetScalerGatewayAddress": "https://ag.tenant1.datacenter1.mydomain.com"
        }
      ],
      "IsAacEnabled": true,
      "AacFarmName": "tenant 1",
      "UsePrivateNetwork": true,
      "PrivateManagementNetwork": "tenant 1 network"
    }

## Response Information

The updated tenant.

### Response type

TenantModel

### Response body formats

#### application/json, text/json

Sample:

    {
      "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
      "Id": "91ade655-feb5-47d3-9585-a5827ad50132",
      "ChangeId": "3",
      "Name": "tenant 1",
      "ShortName": "tenant1",
      "Description": "my first tenant",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "DeleteState": "NotDeleted",
      "StoreFrontIsolationMode": "PrivateServerGroup",
      "ResourceDomain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "UserDomain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "LocationUserGroups": [
        {
          "Id": "66382416-9f1c-46dd-b732-e9566f8cd831",
          "UserGroupName": "DOMAIN\\Tenant1Datacenter1Users",
          "PrimaryDataCenter": {
            "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
            "Name": "datacenter1",
            "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
          },
          "DeleteState": "NotDeleted"
        }
      ],
      "TenantDataCenters": [
        {
          "DataCenter": {
            "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
            "Name": "datacenter1",
            "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
          },
          "NetScalerGatewayAddress": "https://ag.tenant1.datacenter1.csp.com"
        }
      ],
      "NetScalerGatewayIsolationMode": "Private",
      "IsAacEnabled": true,
      "AacFarmName": "tenant 1",
      "UsePrivateNetwork": true,
      "PrivateManagementNetwork": "tenant 1 network",
      "HealthSummary": {
        "ActiveCount": 0,
        "ErrorCount": 0,
        "WarningCount": 0,
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsError": false,
            "IsWarning": false,
            "IsInfo": false,
            "IsActive": true,
            "Type": "Allocation"
          }
        ]
      },
      "InternalStoreFrontSites": [
        "https://sf1.datacenter1.csp.com/StoreFront/tenant1"
      ],
      "ExternalStoreFrontSites": [
        "https://ag.tenant1.datacenter1.csp.com/StoreFront/tenant1"
      ],
      "NumSubscriptions": 12
    }