Skip to main content
PATCH
Update a tenant's details

Authorizations

Authorization
string
header
required

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

tenantId
string<uuid>
required

The tenant: a tenant_id from List tenants (GET /v1/msp/admin/tenants). Must be your own tenant or one beneath it.

Body

application/json

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.

name
null | string

The name of the tenant. Trimmed; an empty value is ignored.

short_name
null | string

A short display name, at most 70 characters. An empty string removes it. A longer value returns 400 with short_name: ["maximum_length_70"].

kind
null | enum<string>

Where the tenant sits in the hierarchy: organization | customer | tenant. Any other value returns 400 with kind: ["unsupported"].

Available options:
organization,
customer,
tenant
contact
null | string

The tenant's primary contact.

notification_email
null | string

The email address that receives notifications for this tenant.

address_1
null | string

First line of the tenant's street address.

address_2
null | string

Second line of the tenant's street address.

city
null | string

The tenant's city.

state
null | string

The tenant's state, province or region.

postal_code
null | string

The tenant's postal or ZIP code.

country_id

The tenant's country: an id from List countries (GET /v1/msp/admin/lookups/countries). An unknown id returns 400 with country_id: ["unsupported"]. Changing it does not move an existing tenant to another hosting region.

industry_id

The tenant's industry: an id from List industries (GET /v1/msp/admin/lookups/industries). An unknown id returns 400 with industry_id: ["unsupported"].

employee_count

The number of employees at the tenant. A negative number returns 400 with employee_count: ["invalid"].

display_currency_code
null | string

The currency the tenant's prices are shown in: a code from List currencies (GET /v1/msp/admin/lookups/currencies). Case-insensitive. An unknown code returns 400 with display_currency_code: ["unsupported"].

support_enabled
null | boolean

Support enabled for tenant.

assigned_technician_user_id
null | string<uuid>

The technician responsible for this tenant: a user_id from List technicians (GET /v1/msp/admin/technicians?tenant_id=…) called with this tenant's id. Anyone else returns 400 with assigned_technician_user_id: ["ineligible"].

mdr_xdr_tenant_id
null | string

The tenant's id in the linked MDR/XDR service.

trial
null | boolean

Send false to end a trial and make the tenant a full tenant; it has no effect on a tenant that is not a trial. A tenant cannot be turned back into a trial: true returns 400 with trial: ["one_way"].

Response

OK

The full details of one tenant.

tenant_id
string<uuid>
required

The tenant's id. Use it as tenantId or parent_tenant_id in the other endpoints.

tenant_host
string
required

The tenant's host name, for example cc2080fe.cyrisma.com.

name
string
required

The name of the tenant.

short_name
null | string
required

The tenant's short display name. Null when none is set.

kind
string
required

Where the tenant sits in the hierarchy: organization | customer | tenant. The CYRISMA top-level tenant is root.

status
string
required

The tenant's state: active | provisioning | suspended | disabled | deleted.

scope_version
required

A counter that increases whenever the tenants beneath this one change, for example when a tenant is created under it. Most integrations can ignore it.

contact
null | string
required

The tenant's primary contact.

notification_email
null | string
required

The email address that receives notifications for this tenant.

address_1
null | string
required

First line of the tenant's street address.

address_2
null | string
required

Second line of the tenant's street address.

city
null | string
required

The tenant's city.

state
null | string
required

The tenant's state, province or region.

postal_code
null | string
required

The tenant's postal or ZIP code.

country_id
required

The tenant's country: an id from List countries (GET /v1/msp/admin/lookups/countries).

industry_id
required

The tenant's industry: an id from List industries (GET /v1/msp/admin/lookups/industries). Null when not set.

industry_name
null | string
required

The name of industry_id. Null when not set.

tenant_type_id
required

The tenant type: an id from List tenant types (GET /v1/msp/admin/lookups/tenant-types). Null when not set.

Values:

  • 0 for MSP
  • 1 for MSSP
  • 2 for Reseller
  • 3 for Client
tenant_type_name
null | string
required

The name of tenant_type_id, for example Client. Null when not set.

employee_count
required

The number of employees at the tenant.

support_enabled
null | boolean
required

Support enabled for tenant.

legacy_assigned_technician_user_id
required

The assigned technician's user id in the legacy CYRISMA platform, kept for migrated tenants. Use assigned_technician_user_id instead.

assigned_technician_user_id
null | string<uuid>
required

The user id of the technician responsible for this tenant. Null when no technician is assigned.

assigned_technician_name
null | string
required

The assigned technician's name, or their email when no name is set. Null when no technician is assigned.

assigned_technician_email
null | string
required

The assigned technician's email, in lower case. Null when no technician is assigned or they have no email.

mdr_xdr_tenant_id
null | string
required

The tenant's id in the linked MDR/XDR service. Null when none is linked.

display_currency_code
string
required

The currency the tenant's prices are shown in: a code from List currencies (GET /v1/msp/admin/lookups/currencies). Defaults to USD.

provisioning_status
null | string
required

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.

trial
boolean
required

True when the tenant is a 21-day trial tenant.

created_at
string<date-time>
required

When the tenant was created: an ISO 8601 timestamp in UTC (offset +00:00), for example 2026-09-16T15:06:58.10164+00:00.

updated_at
string<date-time>
required

When the tenant's record last changed: an ISO 8601 timestamp in UTC (offset +00:00), for example 2026-09-16T15:06:58.10164+00:00.