TENANTS
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$setand$unsetoperators to add, update, or remove individual property keys without touching the rest. Use$setto add new keys or overwrite the value of existing keys. Use$unsetto 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
Authorizations
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
unique identifier of the tenant whose properties you want to update
Body
application/json
- Replace entire payload
- Update individual properties
Replace the entire custom properties object with the payload.
The new custom properties object. Replaces the tenant's existing custom properties in full.
Response
Tenant properties updated. Returns the tenant's identifier fields and its updated properties object.
The tenant with its updated local custom properties.