curl --request PATCH \
--url https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"short_name": "Contoso",
"notification_email": "it@contoso.example",
"employee_count": 300,
"trial": false
}
'import requests
url = "https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}"
payload = {
"short_name": "Contoso",
"notification_email": "it@contoso.example",
"employee_count": 300,
"trial": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
short_name: 'Contoso',
notification_email: 'it@contoso.example',
employee_count: 300,
trial: false
})
};
fetch('https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}', 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://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}",
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([
'short_name' => 'Contoso',
'notification_email' => 'it@contoso.example',
'employee_count' => 300,
'trial' => false
]),
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://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}"
payload := strings.NewReader("{\n \"short_name\": \"Contoso\",\n \"notification_email\": \"it@contoso.example\",\n \"employee_count\": 300,\n \"trial\": false\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"short_name\": \"Contoso\",\n \"notification_email\": \"it@contoso.example\",\n \"employee_count\": 300,\n \"trial\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"short_name\": \"Contoso\",\n \"notification_email\": \"it@contoso.example\",\n \"employee_count\": 300,\n \"trial\": false\n}"
response = http.request(request)
puts response.read_body{
"tenant_id": "5c0e7a92-3f4b-4d1e-a8c6-7b2d9e1f0a34",
"tenant_host": "cc2080fe.cyrisma.com",
"name": "Contoso Ltd",
"short_name": "Contoso",
"kind": "tenant",
"status": "active",
"scope_version": 1,
"contact": "Jane Doe",
"notification_email": "it@contoso.example",
"address_1": "1 Main Street",
"address_2": null,
"city": "Springfield",
"state": "IL",
"postal_code": "62701",
"country_id": 840,
"industry_id": 2,
"industry_name": "Financial Services",
"tenant_type_id": 3,
"tenant_type_name": "Client",
"employee_count": 250,
"support_enabled": true,
"legacy_assigned_technician_user_id": null,
"assigned_technician_user_id": "0b9c4d2e-6f1a-4c83-9e57-d3a8b1f2c640",
"assigned_technician_name": "Sam Taylor",
"assigned_technician_email": "sam.taylor@msp.example",
"mdr_xdr_tenant_id": null,
"display_currency_code": "USD",
"provisioning_status": "deployed",
"trial": false,
"created_at": "2026-09-16T15:06:58.10164+00:00",
"updated_at": "2026-09-20T14:05:12.482301+00:00"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Update a tenant's details
Changes a tenant’s details and returns the updated tenant. Send only the fields to change.
Needs pulse.write.
- 400: a validation problem naming the first invalid field.
- 401 (no body): missing or invalid token, no
pulse.write, or the tenant is outside your hierarchy.
curl --request PATCH \
--url https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"short_name": "Contoso",
"notification_email": "it@contoso.example",
"employee_count": 300,
"trial": false
}
'import requests
url = "https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}"
payload = {
"short_name": "Contoso",
"notification_email": "it@contoso.example",
"employee_count": 300,
"trial": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
short_name: 'Contoso',
notification_email: 'it@contoso.example',
employee_count: 300,
trial: false
})
};
fetch('https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}', 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://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}",
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([
'short_name' => 'Contoso',
'notification_email' => 'it@contoso.example',
'employee_count' => 300,
'trial' => false
]),
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://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}"
payload := strings.NewReader("{\n \"short_name\": \"Contoso\",\n \"notification_email\": \"it@contoso.example\",\n \"employee_count\": 300,\n \"trial\": false\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"short_name\": \"Contoso\",\n \"notification_email\": \"it@contoso.example\",\n \"employee_count\": 300,\n \"trial\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.cyrisma.com/ta/v1/msp/admin/tenants/{tenantId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"short_name\": \"Contoso\",\n \"notification_email\": \"it@contoso.example\",\n \"employee_count\": 300,\n \"trial\": false\n}"
response = http.request(request)
puts response.read_body{
"tenant_id": "5c0e7a92-3f4b-4d1e-a8c6-7b2d9e1f0a34",
"tenant_host": "cc2080fe.cyrisma.com",
"name": "Contoso Ltd",
"short_name": "Contoso",
"kind": "tenant",
"status": "active",
"scope_version": 1,
"contact": "Jane Doe",
"notification_email": "it@contoso.example",
"address_1": "1 Main Street",
"address_2": null,
"city": "Springfield",
"state": "IL",
"postal_code": "62701",
"country_id": 840,
"industry_id": 2,
"industry_name": "Financial Services",
"tenant_type_id": 3,
"tenant_type_name": "Client",
"employee_count": 250,
"support_enabled": true,
"legacy_assigned_technician_user_id": null,
"assigned_technician_user_id": "0b9c4d2e-6f1a-4c83-9e57-d3a8b1f2c640",
"assigned_technician_name": "Sam Taylor",
"assigned_technician_email": "sam.taylor@msp.example",
"mdr_xdr_tenant_id": null,
"display_currency_code": "USD",
"provisioning_status": "deployed",
"trial": false,
"created_at": "2026-09-16T15:06:58.10164+00:00",
"updated_at": "2026-09-20T14:05:12.482301+00:00"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.
Path Parameters
Body
Send only the fields you want to change. A field that is omitted or null keeps its current
value, so fields cannot be cleared this way; the one exception is short_name, which an
empty string removes. The tenant type and the assigned technician cannot be removed here.
Validation failures return 400 with the field name as the key, for example
{"country_id": ["unsupported"]}. Only the first failure is reported.
Response
OK
The full details of one tenant.
The status of the tenant's most recent provisioning job, which may be a create, decommission
or restore: queued | leased | running | deployed | decommissioned | failed.
Null for tenants that have never had a job, such as tenants migrated from the legacy platform.
