Send a transactional notification
Sends a transactional notification to a contact through specified channels. Requires authentication.
post/api/transactional.send
Request body
Example request
{
"workspace_id": "ws_1234567890",
"notification": {
"id": "welcome_email",
"external_id": "txn_12345",
"contact": {
"email": "user@example.com",
"external_id": "user_12345",
"timezone": "America/New_York",
"language": "en-US",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"phone": "+15551234567",
"address_line_1": "123 Main St",
"address_line_2": "Apt 4B",
"country": "US",
"postcode": "10001",
"state": "NY",
"job_title": "Software Engineer",
"custom_string_1": "Premium tier",
"custom_number_1": 42,
"custom_datetime_1": "2023-06-01T09:00:00Z",
"custom_json_1": {
"preferences": {
"theme": "dark",
"notifications": true
}
},
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-04-22T15:45:00Z",
"contact_lists": [
{
"email": "user@example.com",
"list_id": "newsletter",
"list_name": "Newsletter",
"status": "active",
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-01-15T10:30:00Z",
"deleted_at": null
}
],
"contact_segments": [
{
"email": "user@example.com",
"segment_id": "premium_users",
"version": 1,
"matched_at": "2023-01-15T10:30:00Z",
"computed_at": "2023-01-15T10:30:00Z"
}
]
},
"channels": [
"email"
],
"data": {
"user_name": "John Doe",
"activation_link": "https://example.com/activate/abc123"
},
"metadata": {
"campaign_id": "spring_promo_2023",
"source": "user_signup"
},
"email_options": {
"from_name": "Support Team",
"subject": "Welcome, {{ name }}!",
"subject_preview": "Your order has been confirmed",
"cc": [
"manager@example.com"
],
"bcc": [
"archive@example.com"
],
"reply_to": "support@example.com",
"attachments": [
{
"filename": "invoice.pdf",
"content": "JVBERi0xLjQKJeLjz9MKMy4uLg==",
"content_type": "application/pdf",
"disposition": "attachment"
}
]
}
}
}Response
Notification sent successfully
Example response
{
"message_id": "msg_1234567890abcdef",
"success": true
}