Skip to main content
PUT
/
tenants
/
{tenant_id}
Update Tenant
curl --request PUT \
  --url https://api.example.com/tenants/{tenant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "billing_plan": "<string>",
  "sip_enabled": true,
  "recording_enabled": true,
  "analytics_enabled": true,
  "max_concurrent_calls": 500,
  "monthly_call_limit": 1,
  "status": "<string>"
}
'
import requests

url = "https://api.example.com/tenants/{tenant_id}"

payload = {
"name": "<string>",
"billing_plan": "<string>",
"sip_enabled": True,
"recording_enabled": True,
"analytics_enabled": True,
"max_concurrent_calls": 500,
"monthly_call_limit": 1,
"status": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
billing_plan: '<string>',
sip_enabled: true,
recording_enabled: true,
analytics_enabled: true,
max_concurrent_calls: 500,
monthly_call_limit: 1,
status: '<string>'
})
};

fetch('https://api.example.com/tenants/{tenant_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/tenants/{tenant_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'billing_plan' => '<string>',
'sip_enabled' => true,
'recording_enabled' => true,
'analytics_enabled' => true,
'max_concurrent_calls' => 500,
'monthly_call_limit' => 1,
'status' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/tenants/{tenant_id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"billing_plan\": \"<string>\",\n \"sip_enabled\": true,\n \"recording_enabled\": true,\n \"analytics_enabled\": true,\n \"max_concurrent_calls\": 500,\n \"monthly_call_limit\": 1,\n \"status\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.example.com/tenants/{tenant_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"billing_plan\": \"<string>\",\n \"sip_enabled\": true,\n \"recording_enabled\": true,\n \"analytics_enabled\": true,\n \"max_concurrent_calls\": 500,\n \"monthly_call_limit\": 1,\n \"status\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/tenants/{tenant_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"billing_plan\": \"<string>\",\n \"sip_enabled\": true,\n \"recording_enabled\": true,\n \"analytics_enabled\": true,\n \"max_concurrent_calls\": 500,\n \"monthly_call_limit\": 1,\n \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "billing_plan": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "monthly_usage_cents": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sip_enabled": false,
  "recording_enabled": true,
  "analytics_enabled": true,
  "max_concurrent_calls": 10,
  "monthly_call_limit": 1000,
  "meta_data": {},
  "sip_domain": "<string>",
  "sip_username": "<string>",
  "hipaa_enabled": false,
  "pci_enabled": false,
  "recording_format": "mp4",
  "retention_days": 90,
  "data_encryption_enabled": true,
  "webhook_url": "<string>",
  "webhook_timeout_seconds": 20
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenant_id
string<uuid>
required

Body

application/json

Tenant update model.

name
string | null
Required string length: 1 - 255
billing_plan
string | null
sip_enabled
boolean | null
recording_enabled
boolean | null
analytics_enabled
boolean | null
max_concurrent_calls
integer | null
Required range: 1 <= x <= 1000
monthly_call_limit
integer | null
Required range: x >= 0
status
string | null

Response

Successful Response

Tenant response model.

name
string
required
Required string length: 1 - 255
billing_plan
string
required
Required string length: 1 - 100
id
string<uuid>
required
status
string
required
monthly_usage_cents
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
sip_enabled
boolean
default:false
recording_enabled
boolean
default:true
analytics_enabled
boolean
default:true
max_concurrent_calls
integer
default:10
Required range: 1 <= x <= 1000
monthly_call_limit
integer
default:1000
Required range: x >= 0
meta_data
Meta Data · object | null
sip_domain
string | null
sip_username
string | null
hipaa_enabled
boolean
default:false
pci_enabled
boolean
default:false
recording_format
string
default:mp4
retention_days
integer
default:90
data_encryption_enabled
boolean
default:true
webhook_url
string | null
webhook_timeout_seconds
integer
default:20