Tenants
Set a tenant
Sets a tenant within an environment, performing an upsert operation. Any existing properties will be merged with the incoming properties.
put/v1/tenants/{id}
Path parameters
idstring required
The unique identifier for the tenant.
Query parameters
resolve_full_preference_settingsboolean
When true, merges environment-level default preferences into the tenant's settings.preference_set field before returning the response. Defaults to false.
Request body
Example request
{
"name": "Jurassic Park",
"settings": {
"branding": {
"icon_url": "https://example.com/trex_silhouette_icon.png",
"logo_url": "https://example.com/amber_fossil_logo.png",
"primary_color": "#DF1A22",
"primary_color_contrast": "#FFDE00"
}
}
}Response
OK
Example response
{
"__typename": "Tenant",
"id": "tenant_jp123",
"name": "Jurassic Park",
"settings": {
"branding": {
"icon_url": "https://example.com/trex_silhouette_icon.png",
"logo_url": "https://example.com/amber_fossil_logo.png",
"primary_color": "#DF1A22",
"primary_color_contrast": "#FFDE00"
},
"preference_set": {
"categories": {
"safety": {
"channel_types": {
"email": true,
"push": true
}
}
},
"channel_types": {
"email": true,
"in_app_feed": true,
"push": true
},
"id": "default",
"workflows": {
"park_alert": {
"channel_types": {
"email": true,
"push": true
}
}
}
}
}
}