Skip to content

Update tenant

Request to update existing tenant:

PUT /api/v2/tenants/<tenant-id>.json

HTTP body should contain JSON formatted profile of tenant to update.

For example:

{
    "tenant": {
        "name": "New Tenant Name"
    }
}

Response contains HTTP status code as shown in the following table.

Response Description
200 OK Tenant has been successfully updated
403 Forbidden The request cannot be completed because API user has no permission to edit tenants
400 Bad Request

The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

{"error": "InvalidRecord","description": "Record Validation errors","details": ["name": "Tenant with such name exists already"]}