Skip to main content
POST
/
tenants
Create Tenant
curl --request POST \
  --url https://api.example.com/tenants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "billing_plan": "<string>",
  "sip_enabled": false,
  "recording_enabled": true,
  "analytics_enabled": true,
  "max_concurrent_calls": 10,
  "monthly_call_limit": 1000,
  "sip_domain": "<string>",
  "sip_username": "<string>",
  "sip_password": "<string>"
}
'
import requests

url = "https://api.example.com/tenants"

payload = {
    "name": "<string>",
    "billing_plan": "<string>",
    "sip_enabled": False,
    "recording_enabled": True,
    "analytics_enabled": True,
    "max_concurrent_calls": 10,
    "monthly_call_limit": 1000,
    "sip_domain": "<string>",
    "sip_username": "<string>",
    "sip_password": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    billing_plan: '<string>',
    sip_enabled: false,
    recording_enabled: true,
    analytics_enabled: true,
    max_concurrent_calls: 10,
    monthly_call_limit: 1000,
    sip_domain: '<string>',
    sip_username: '<string>',
    sip_password: '<string>'
  })
};

fetch('https://api.example.com/tenants', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'billing_plan' => '<string>',
    'sip_enabled' => false,
    'recording_enabled' => true,
    'analytics_enabled' => true,
    'max_concurrent_calls' => 10,
    'monthly_call_limit' => 1000,
    'sip_domain' => '<string>',
    'sip_username' => '<string>',
    'sip_password' => '<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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"billing_plan\": \"<string>\",\n  \"sip_enabled\": false,\n  \"recording_enabled\": true,\n  \"analytics_enabled\": true,\n  \"max_concurrent_calls\": 10,\n  \"monthly_call_limit\": 1000,\n  \"sip_domain\": \"<string>\",\n  \"sip_username\": \"<string>\",\n  \"sip_password\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/tenants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"billing_plan\": \"<string>\",\n  \"sip_enabled\": false,\n  \"recording_enabled\": true,\n  \"analytics_enabled\": true,\n  \"max_concurrent_calls\": 10,\n  \"monthly_call_limit\": 1000,\n  \"sip_domain\": \"<string>\",\n  \"sip_username\": \"<string>\",\n  \"sip_password\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"billing_plan\": \"<string>\",\n  \"sip_enabled\": false,\n  \"recording_enabled\": true,\n  \"analytics_enabled\": true,\n  \"max_concurrent_calls\": 10,\n  \"monthly_call_limit\": 1000,\n  \"sip_domain\": \"<string>\",\n  \"sip_username\": \"<string>\",\n  \"sip_password\": \"<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.

Body

application/json

Tenant creation model.

name
string
required
Required string length: 1 - 255
billing_plan
string
required
Required string length: 1 - 100
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
sip_domain
string | null
sip_username
string | null
sip_password
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