Skip to main content
POST
/
orgs
/
{org_id}
/
broadcasts
/
{broadcast_id}
/
send
Send a Transactional Broadcast
curl --request POST \
  --url https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_channel_id": "<string>",
  "contact_id": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "name": "<string>",
  "variables": {},
  "template_ids": [
    "<string>"
  ],
  "background": true
}
'
{
  "recipients": [
    {
      "id": "<string>",
      "broadcast_id": "<string>",
      "broadcast_name": "<string>",
      "template_id": "<string>",
      "user_id": "<string>",
      "name": "<string>",
      "username": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "is_skipped": true,
      "is_skipped_at": "2023-11-07T05:31:56Z",
      "is_failed": true,
      "is_failed_at": "2023-11-07T05:31:56Z",
      "is_bounced": true,
      "is_bounced_at": "2023-11-07T05:31:56Z",
      "is_sent": true,
      "is_sent_at": "2023-11-07T05:31:56Z",
      "is_delivered": true,
      "is_delivered_at": "2023-11-07T05:31:56Z",
      "is_complained": true,
      "is_complained_at": "2023-11-07T05:31:56Z",
      "is_unsubscribed": true,
      "is_unsubscribed_at": "2023-11-07T05:31:56Z",
      "is_opened": true,
      "is_opened_at": "2023-11-07T05:31:56Z",
      "is_played": true,
      "is_played_at": "2023-11-07T05:31:56Z",
      "error_message": "<string>",
      "external_message_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "contact": {
        "id": "<string>",
        "name": "<string>",
        "blocked": true,
        "unsubscribed": true,
        "is_admin": true,
        "channels": [
          {
            "id": "<string>",
            "user_id": "<string>",
            "avatar": "<string>",
            "name": "<string>",
            "username": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "country": "<string>",
            "agent": "<string>",
            "ip": "<string>",
            "language": "<string>",
            "platform_data": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "link": "<string>"
          }
        ],
        "segments": [
          {
            "id": "<string>",
            "name": "<string>",
            "contacts_count": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "properties": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "blocked_at": "2023-11-07T05:31:56Z",
        "unsubscribed_at": "2023-11-07T05:31:56Z",
        "unsubscribe_reason": "<string>",
        "unsubscribe_feedback": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.useinvent.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
org_id
string
required

Org ID

​
broadcast_id
string
required

Broadcast ID

Body

Schema for firing one trigger on a transactional broadcast. Recipient identifier fields are at the root. Fans out across the broadcast templates to a single recipient.

​
contact_channel_id
string

Tier 1 (most specific): exact ContactChannel id. Skips contact resolution and channel-availability filter since the caller has chosen the channel.

​
contact_id
string

Tier 2: known Contact id. Channel is inferred per template at send time.

​
phone
string

Raw phone. When no contact is resolved by contact_channel_id/contact_id, it find-or-creates a contact by phone. When a contact is resolved, it overrides the phone used for this send only (the contact and its channels are not modified).

Maximum string length: 256
​
email
string

Raw email. When no contact is resolved by contact_channel_id/contact_id, it find-or-creates a contact by email. When a contact is resolved, it overrides the email used for this send only (the contact and its channels are not modified).

Maximum string length: 256
​
name
string

Optional display name override for this send only. Takes precedence over the resolved channel and contact name. Does not resolve or create a contact on its own and does not modify the contact.

Maximum string length: 256
​
variables
object

Values for the broadcast fields. Variables override the contact's stored field values. Any broadcast field you omit falls back to its configured default value.

​
template_ids
string[]

Optional subset of broadcast templates to fire. Omit to fire all templates on the broadcast.

​
background
boolean

When false (default), the call awaits the send and returns external_message_id per template. When true, the call enqueues and returns immediately.

Response

200 - application/json

Result of triggering a transactional broadcast. One BroadcastRecipient row per template fired.

​
recipients
object[]
required