Skip to main content
POST
Send Message
string
required

Request Body

Request Fields

Required Fields

string
required
The communication channel. One of: EMAIL, SMS, WHATSAPP, SLACK, TEAMS, DISCORD, LINE, IN_APP, PUSH
object
required
The destination for the message. Must include the field matching the selected channel.

Optional Fields

object
Template configuration for the message
object
Key-value pairs to populate template placeholders
object
Provider configuration
string
Message subject (for EMAIL only)
string
Message body (for SLACK, EMAIL, TEAMS)
array
Interactive buttons (for SLACK only)

Response

Success Response (200 OK)

Response Fields

UUID
Unique identifier for the sent message

Error Responses

  • 400 - Bad Request (Invalid request format or missing required fields)
  • 401 - Unauthorized (Missing or invalid API key)
  • 403 - Forbidden (Insufficient permissions to send message)
  • 404 - Not Found (Template or provider not found)
  • 429 - Too Many Requests
  • 500 - Internal Server Error

Examples