Skip to main content
cURL

Authorizations

Authorization
string
header
required

An Admin API key, sent as Authorization: Bearer <key>. Create one in Settings.

Body

application/json
workspaceId
string
required
channel
required
Available options:
Email
contents
object
required
userProperties
object
required
subscriptionGroupId
string
tags
object
locale
string

BCP-47 language tag: 'en', 'ar', or 'ar-EG'

Pattern: ^[a-z]{2,3}(-[A-Z]{2})?$

Response

Default Response

contents
object
required
diagnostics
object