Create Email Branding

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates the given email branding. If the upsert query param is set to truethen, instead of performing a create, the API will switch to performing an upsert. For an upsert request, the following fields are required:

Required Upsert Fields:

  • ownerType
  • ownerId

When performing an upsert, the above fields will be used to determine whether the email branding resource already exists. If the email branding already exists, a partial update will be performed; otherwise, a new email branding entity will be created.

In the response of an upsert request, if a create was performed, then a 201 response code will be returned; otherwise, if an update was performed, then a 200 will be returned.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
email-branding:writeApplicationThe subject can create email brandings for the application the subject belongs to.
TenantThe subject can create email brandings for the tenant the subject belongs to.
Tenant Inclusion ListThe subject can create email brandings for tenants specified in the tenant inclusion list.
Tenant Exclusion ListThe subject can create email brandings for tenants in the subject's application who are not on the tenant exclusion list.
Query Params
boolean
Defaults to false
Body Params

Email Branding JSON object

string
enum
required
length between 1 and 30
Allowed:
string
required
length between 1 and 26
string
length between 7 and 7
string
length between 7 and 7
integer
0 to 32
string
length between 7 and 7
boolean
Defaults to true
uri
length between 1 and 2000
integer
16 to 96
Defaults to 64
integer
16 to 550
Defaults to 297
string
length between 1 and 60
uri
length between 1 and 2000
uri
length between 1 and 2000
string
length between 1 and 200
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json