curl --request PATCH \
--url https://api.getdialed.ai/v1/tenants/{tenancy_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"label": "Acme Corp (EU)"
}
'import requests
url = "https://api.getdialed.ai/v1/tenants/{tenancy_id}"
payload = { "label": "Acme Corp (EU)" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: 'Acme Corp (EU)'})
};
fetch('https://api.getdialed.ai/v1/tenants/{tenancy_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.getdialed.ai/v1/tenants/{tenancy_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => 'Acme Corp (EU)'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.getdialed.ai/v1/tenants/{tenancy_id}"
payload := strings.NewReader("{\n \"label\": \"Acme Corp (EU)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.patch("https://api.getdialed.ai/v1/tenants/{tenancy_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Acme Corp (EU)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/tenants/{tenancy_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Acme Corp (EU)\"\n}"
response = http.request(request)
puts response.read_body{
"buckets": {
"Upload": {
"caps": {
"60": 20,
"3600": 400,
"86400": 2000
},
"effective": {
"60": 16,
"3600": 320,
"86400": 1600
},
"label": "Uploading (batch)",
"margin_pct": 80,
"max_records_per_request": 50000,
"min_interval_ms": 250,
"observed_at": "2026-08-22T18:00:00Z",
"source": "live"
}
},
"counters_synced_at": "2026-08-22T18:00:00Z",
"created_at": "2026-08-22T17:00:00Z",
"id": "ten_9f2c1a7b3d4e5f60",
"is_manual": false,
"label": "Acme Corp",
"org_id": "org_a1b2c3d4",
"platform_id": "five9",
"status": "active",
"sync_status": "live",
"updated_at": "2026-08-22T18:00:00Z"
}{
"detail": "Authentication required"
}{
"detail": "Admin role required"
}{
"detail": "Tenant not found"
}{
"detail": "is_manual=true and platform_id disagree"
}{
"detail": "Rate limit exceeded: 100 per 1 minute"
}Rename a tenant
Admin only. Change a tenant’s display label — and only its label. Nothing is keyed on the label, so no credential, no stored rate budget and no queued work is affected by a rename. Any field other than label in the body is rejected: a tenant’s identity is fixed when it is created, because the records that point at it are keyed on that identity. Cross-tenant access returns 404, never 403.
curl --request PATCH \
--url https://api.getdialed.ai/v1/tenants/{tenancy_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"label": "Acme Corp (EU)"
}
'import requests
url = "https://api.getdialed.ai/v1/tenants/{tenancy_id}"
payload = { "label": "Acme Corp (EU)" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: 'Acme Corp (EU)'})
};
fetch('https://api.getdialed.ai/v1/tenants/{tenancy_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.getdialed.ai/v1/tenants/{tenancy_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => 'Acme Corp (EU)'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.getdialed.ai/v1/tenants/{tenancy_id}"
payload := strings.NewReader("{\n \"label\": \"Acme Corp (EU)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.patch("https://api.getdialed.ai/v1/tenants/{tenancy_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Acme Corp (EU)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/tenants/{tenancy_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Acme Corp (EU)\"\n}"
response = http.request(request)
puts response.read_body{
"buckets": {
"Upload": {
"caps": {
"60": 20,
"3600": 400,
"86400": 2000
},
"effective": {
"60": 16,
"3600": 320,
"86400": 1600
},
"label": "Uploading (batch)",
"margin_pct": 80,
"max_records_per_request": 50000,
"min_interval_ms": 250,
"observed_at": "2026-08-22T18:00:00Z",
"source": "live"
}
},
"counters_synced_at": "2026-08-22T18:00:00Z",
"created_at": "2026-08-22T17:00:00Z",
"id": "ten_9f2c1a7b3d4e5f60",
"is_manual": false,
"label": "Acme Corp",
"org_id": "org_a1b2c3d4",
"platform_id": "five9",
"status": "active",
"sync_status": "live",
"updated_at": "2026-08-22T18:00:00Z"
}{
"detail": "Authentication required"
}{
"detail": "Admin role required"
}{
"detail": "Tenant not found"
}{
"detail": "is_manual=true and platform_id disagree"
}{
"detail": "Rate limit exceeded: 100 per 1 minute"
}Authorizations
Path Parameters
Body
A new display label for a tenant.
Renaming a tenant changes its label and nothing else — no credential, no stored rate budget and no queued work is affected, because none of them is keyed on the label. Any other field in the body is rejected: a tenant's identity is fixed when it is created, and the records that point at it are keyed on that identity.
1 - 200Response
Successful Response
One tenant: the record that anchors a credential and its rate budget.
A tenant is the thing your credentials belong to — a vendor account discovered from the credentials themselves (a Five9 Domain, for example), or a tenant you named yourself when the platform has nothing to discover. N credentials against the same tenant share ONE rate budget.
Each rate bucket reports the provider's raw caps per time window, the
operator's margin_pct safety margin, and the effective budget computed
from both. min_interval_ms is the minimum spacing enforced between two
consecutive calls on the bucket — a floor applied on top of the window
budget, so a bucket can be well inside its hourly cap and still be paced;
null means no explicit floor. The margin is deliberately NOT applied to it
(it multiplies call counts, and shortening a duration would loosen the
budget rather than tighten it). is_manual is true for a tenant you named
rather than one
discovered from a vendor, and such a tenant has no provider-published caps,
so its budget is empty. sync_status reports whether the caps are
provider-observed (live), catalog defaults (catalog_default), or
unchanged after a refresh returned unusable counters (stale).
Show child attributes
Show child attributes