Update a tenant

Use a PUT request to update a tenant. You can only update certain attributes, which are specified in the Response parameters list. You'll need MANAGE_TENANT permissions to perform this operation.

Request

Sample request

The request below update a tenant by setting the active parameter to false:

curl -X PUT -H "Content-Type: application/json" 
https://api.cxengage.net/v1/tenants/<tenantId> -d '

{
	"name": "Test A.A",
      "timezone": "US/Central",
	"active": false,
	"cxengageIdentityProvider": "enabled",
	"outboundIntegrationId": "627502f0-497f-11e8-a154-9ca92fb1d99b",
	"defaultIdentityProvider": null,
	"defaultSlaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Request parameters

The table below lists the parameters you can include in a request:

Parameter	Required	Type	Description
tenantId	yes	UUID	The unique identifier of the tenant.
name	no	string	The human-readable name of the tenant.t.
description	no	string	A short description of the tenant
timezone	no	string	The unique identifier of the tenant.
active	no	boolean	Either true or false.
defaultSlaId	no	UUID	The unique identifier for the default Service Level Agreement (SLA) for this tenant. This SLA is used for any queue that doesn't have a specific SLA assigned to it
cxengageIdentityProvider	no	UUID	Indicates whether the configured identity provider is: Enabled—Allows users to use their CxEngage username and password to authenticate. This setting can be overwritten for individual users. Disabled—Prevents users from using their CxEngage username and password to authenticate. This setting can be overwritten for individual users. Denied—Prevents all users on the tenant from using their CxEngage username and password to authenticate regardless of their user settings.
outboundIntegrationId	no	UUID	The unique identifier of the tenant.
defaultIdentityProvider	no	UUID	The unique identifier of the default identity provider for the tenant.

Response

Sample response

The request returns JSON structured like the example below:

                    {
    "result": {
        "description": Tenant A,
        "parentIds": [
            "57e2f960-3328-11e6-8dd4-c88eee4d9f61"
        ],
        "timezone": "US/Eastern",
        "regionId": "46d74400-3328-11e6-8dd4-c88eee4d9f61",
        "createdBy": "192338d0-3cc6-11e8-a90c-e5d2e6c2ff0d",
        "parent": {
            "id": "57e2f960-3328-11e6-8dd4-c88eee4d9f61",
            "name": "Platform"
        },
        "defaultIdentityProvider": null,
        "updated": "2018-06-19T18:47:36Z",
        "name": "Tenant A",
        "clientLogLevel": null,
        "adminUserId": "192338d0-3cc6-11e8-a90c-e5d2e6c2ff0d",
        "created": "2018-06-19T18:47:36Z",
        "outboundIntegrationId": null,
        "updatedBy": "192338d0-3cc6-11e8-a90c-e5d2e6c2ff0d",
        "active": true,
        "id": "91675efb-719e-4ca2-b342-e9c1738ece63",
        "capacityRuleId": null,
	 "defaultSlaId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "cxengageIdentityProvider": "enabled",
        "childIds": [],
        "parentId": "57e2f960-3328-11e6-8dd4-c88eee4d9f61"
    }
}

Response parameters

The response includes the following parameters:

Parameter	Type	Description
description	string	A brief description of the tenant.
parentIds	UUID	If this is a sub-tenant, an object containing a list of unique identifiers of any parent tenants. If this isn't a sub-tenant, this defaults to the platform ID.
timezone	string	The tenant's timezone, in TZ database format. This consists of a continent/city pair - for example, US/Central.
regionId	UUID	The unique identifier of the AWS region in which the tenant resides.
createdBy	UUID	The unique identifier of the user who create the tenant.
parent	object	A JSON object that includes the name and UUID of the parent tenant.
defaultIdentityProvider	string	The unique identifier of the default identity provider for the tenant.
updated	string	The date and time (in UTC format) on which the tenant was updated.
name	string	The name of the tenant. The name can consist of any alphanumeric or special character. The tenant’s name must be unique across all tenants and AWS regions.
clientLogLevel	string	This property is used by Enghouse Interactive internal.
adminUserId	UUID	The unique identifier of the user who administers the tenant. The default is the ID of the user who created the tenant.
created	string	The date and time (in UTC format) on which the tenant was created.
outboundIntegrationId	string	The unique identifier of the default outbound gateway.
updatedBy	UUID	The unique identifier of the user who updated the tenant.
active	boolean	A flag indicating whether or not the tenant is enabled. You can create a tenant or sub-tenant but not enable it. The default value is true (enabled).
id	UUID	The unique identifier of the tenant.
defaultSlaId	UUID	The unique identifier for the default Service Level Agreement (SLA) for this tenant. This SLA is used for any queue that doesn't have a specific SLA assigned to it
cxengageIdentityProvider	boolean	Indicates whether the configured identity provider is: Enabled—Allows users to use their CxEngage username and password to authenticate. This setting can be overwritten for individual users. Disabled—Prevents users from using their CxEngage username and password to authenticate. This setting can be overwritten for individual users. Denied—Prevents all users on the tenant from using their CxEngage username and password to authenticate regardless of their user settings.
childIds	object	A JSON object that includes the UUIDs of this tenant's child tenants.
parentId	UUID	If this is a sub-tenant, the parent tenant’s ID. If this isn't a sub-tenant, this defaults to the platform ID.