Create new Message

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/messages

Path Params

tenantId

string

required

Tenant identifier.

Body Params

brandCode

string

required

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

name

string

required

The normalized displayName.

displayName

string

required

The value to display for a given locale. displayValue entities allow for built-in translation. Values can be set depending on the possible locales, so that the associated information can be displayed in the appropriate language for a locale.

description

string

required

Description.

templateTitle

string

required

Template title.

templateBody

string

required

Template body.

locale

string

enum

required

Locale in [ISO 639-1]-[ISO 3166-1] format.

Allowed:

enabled

boolean

required

Enabled.

notificationMethod

string

enum

required

Allowed:

customSenderName

string

Custom sender name.

Responses

201

Created notification type.

403

Forbidden.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!