Update Tenant Properties
Update a tenant's custom properties in one of two ways:
- Replace entire payload — send { "properties": { ... } } to replace the entire custom properties object with the payload. Any custom property key not in the payload is removed.
- Update individual properties — send { "operations": [ ... ] } with $set and $unset operators to add, update, or remove individual property keys without touching the rest. Use $set to add new keys or overwrite the value of existing keys. Use $unset to delete existing keys.
Only custom properties are affected by this endpoint. Use the Create / Update Tenants endpoint to update reserved fields such as branding, blocked_channels, or parent_id.
patch/v1/tenant/{tenant_id}/properties/
Path parameters
tenant_idstring required
unique identifier of the tenant whose properties you want to update
Request body
Response
Tenant properties updated. Returns the tenant's identifier fields and its updated properties object.
object required
The tenant with its updated local custom properties.
Changes
Changed in 1 of the 7 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○