Update existing MSP child tenant

patch

https://core-api.ternary.app/api/tenants/{tenantID}

Update an existing child tenant's configuration. Only the fields included in the request body are modified; omitted fields remain unchanged. This endpoint is only available to MSP parent tenants.

Common updates include changing the tenant name, fiscal calendar, notification preferences, preferred currency, or status.

See MSP Customer Management for detailed MSP administration guidance.

Path Params

tenantID

uuid

required

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

A unique identifier for an organization

Body Params

fiscalCalendar

object

Fiscal-year boundary and per-period end dates. Period keys follow M{MM}-Q{Q}-Y{YYYY} (e.g. M01-Q1-Y2026); values are YYYY-MM-DD period-end dates.

emailDomain

string

length ≥ 1

Tenant email domain

name

string

length ≥ 1

Tenant name

newUserNotifications

object

Default notification preferences applied to users newly added to the tenant. Each flag toggles a notification channel.

preferredCurrencyCode

string

enum

Defaults to USD

Preferred Tenant currency code

status

string

enum

Tenant operational status. ACTIVE: tenant is fully operational. INACTIVE: tenant is suspended; data ingestion and user access are halted but data is retained.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Operation

400Bad Request

401Unauthorized

403Forbidden