PATCH /api/tenants/{id}

Updates metadata about a tenant.

Request

Parameter Description Additional information
id The id of the tenant to update. Define this parameter in the url.
options The updated properties. Define this parameter in the body.

Example

{
  "Comment": "sample string 1"
}

Response

Returns the updated tenant.

Example

{
  "Id": 23,
  "Name": "prefix-tenantname",
  "DeploymentStatus": null,
  "Status": "Running",
  "ResourceGroup": "prefix-grp-eastus-180912",
  "HostName": "instancename.domain.com",
  "Cname": "instancename.domain.com",
  "DatabaseServer": "prefix-sql-eastus-180919",
  "DatabaseName": "prefix-instancename",
  "CreatedAt": "2021-10-12T02:20:06.4483303Z",
  "CreatedBy": null,
  "TrashedAt": null,
  "TrashedBy": null,
  "Configuration": "{\"ThemeColor\":\"#ff00ff\",\"ThemeName\":\"Social HQ\"}",
  "Version": "4.3.2",
  "LicenseKey": null,
  "License": {
    "Key": "8CZB5-UTM8U-3GG5U-G1AAP",
    "IssuedTo": "company",
    "GraceDays": 10
  },
  "Comment": "A comment",
  "Title": "instancename",
  "Url": "https://instancename.domain.com",
  "IsTrashed": false
}