Sign up
Login
Search...
/
Getting Started
Authentication
Idempotent Requests
Rate Limiting
Reference
POST
Send a message
Audiences
Audit Events
Auth Tokens
Automations
Brands
Bulk
Inbound
Lists
Messages
Notifications
Profiles
Templates
Tenants
PUT
Create or Replace a Tenant
GET
Get a Tenant
GET
Get a List of Tenants
DEL
Delete a Tenant
GET
Get Users in Tenant
PUT
Create or Replace Default Preferences For Topic
DEL
Remove Default Preferences For Topic
Translations
Users
Sign up
Login
Reference
Tenants
Create or Replace a Tenant
PUT
https://api.courier.com
/
tenants
/
:tenant_id
Path parameters
tenant_id
string
Required
A unique identifier representing the tenant to be returned.
Request
This endpoint expects an object.
name
string
Required
Name of the tenant.
parent_tenant_id
string
Optional
Tenant's parent id (if any).
default_preferences
object
Optional
Defines the preferences used for the tenant when the user hasn't specified their own.
Show property
properties
map from strings to any
Optional
Arbitrary properties accessible to a template.
user_profile
map from strings to any
Optional
A user profile object merged with user profile on send.
brand_id
string
Optional
Brand to be used for the account when one is not specified by the send call.
Response
This endpoint returns an object.
id
string
Id of the tenant.
name
string
Name of the tenant.
parent_tenant_id
string
Optional
Tenant's parent id (if any).
default_preferences
object
Optional
Defines the preferences used for the account when the user hasn't specified their own.
Show property
properties
map from strings to any
Optional
Arbitrary properties accessible to a template.
user_profile
map from strings to any
Optional
A user profile object merged with user profile on send.
brand_id
string
Optional
Brand to be used for the account when one is not specified by the send call.
Built with