Send transactional broadcast

POST

orgs

{org_id}

broadcasts

{broadcast_id}

send

Send 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>",
  "subject": "<string>",
  "body": "<string>",
  "message": "<string>",
  "reply_to": "<string>",
  "variables": {},
  "template_ids": [
    "<string>"
  ],
  "background": true
}
'

import requests

url = "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send"

payload = {
    "contact_channel_id": "<string>",
    "contact_id": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "body": "<string>",
    "message": "<string>",
    "reply_to": "<string>",
    "variables": {},
    "template_ids": ["<string>"],
    "background": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contact_channel_id: '<string>',
    contact_id: '<string>',
    phone: '<string>',
    email: '<string>',
    name: '<string>',
    subject: '<string>',
    body: JSON.stringify('<string>'),
    message: '<string>',
    reply_to: '<string>',
    variables: {},
    template_ids: ['<string>'],
    background: true
  })
};

fetch('https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'contact_channel_id' => '<string>',
    'contact_id' => '<string>',
    'phone' => '<string>',
    'email' => '<string>',
    'name' => '<string>',
    'subject' => '<string>',
    'body' => '<string>',
    'message' => '<string>',
    'reply_to' => '<string>',
    'variables' => [
        
    ],
    'template_ids' => [
        '<string>'
    ],
    'background' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send"

	payload := strings.NewReader("{\n  \"contact_channel_id\": \"<string>\",\n  \"contact_id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"message\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"variables\": {},\n  \"template_ids\": [\n    \"<string>\"\n  ],\n  \"background\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact_channel_id\": \"<string>\",\n  \"contact_id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"message\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"variables\": {},\n  \"template_ids\": [\n    \"<string>\"\n  ],\n  \"background\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contact_channel_id\": \"<string>\",\n  \"contact_id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"message\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"variables\": {},\n  \"template_ids\": [\n    \"<string>\"\n  ],\n  \"background\": true\n}"

response = http.request(request)
puts response.read_body

{
  "recipients": [
    {
      "id": "<string>",
      "broadcast_id": "<string>",
      "broadcast_name": "<string>",
      "template_id": "<string>",
      "channel_type": "internal",
      "user_id": "<string>",
      "name": "<string>",
      "username": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "status": "QUEUED",
      "source": "API",
      "payload": {},
      "retries": 123,
      "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>",
      "interactions": [
        {
          "type": "CLICK",
          "label": "<string>",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "contact": {
        "id": "<string>",
        "name": "<string>",
        "blocked": true,
        "unsubscribed": true,
        "ai_replies": true,
        "is_admin": true,
        "channels": [
          {
            "id": "<string>",
            "type": "internal",
            "user_id": "<string>",
            "avatar": "<string>",
            "name": "<string>",
            "username": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "country": "<string>",
            "agent": "<string>",
            "ip": "<string>",
            "language": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "link": "<string>"
          }
        ],
        "segments": [
          {
            "id": "<string>",
            "name": "<string>",
            "color": "red",
            "contacts_count": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "fields": {},
        "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>",
        "ai_replies_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

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

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

subject

string

Replaces the configured subject on every email template of this broadcast, for this send only. Supports {{variable}} placeholders.

Maximum string length: 1000

body

string

Replaces the configured body (HTML) on every email template of this broadcast, for this send only. Supports {{variable}} placeholders.

Maximum string length: 524288

message

string

Replaces the configured message text on every SMS template of this broadcast, for this send only. Supports {{variable}} placeholders.

Maximum string length: 4000

reply_to

string

Replaces the configured reply-to address on every email template of this broadcast, for this send only. Supports {{variable}} placeholders.

Maximum string length: 512

variables

object

Per-recipient values by name: a template slot (a WhatsApp variable such as body_1 or body_customer_name, an email subject, an SMS message) or a {{name}} written in a template. A slot you omit goes out as configured in the channel editor.

Show child attributes

template_ids

string[]

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

Maximum string length: 128

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

Show child attributes

Send 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>",
  "subject": "<string>",
  "body": "<string>",
  "message": "<string>",
  "reply_to": "<string>",
  "variables": {},
  "template_ids": [
    "<string>"
  ],
  "background": true
}
'

import requests

url = "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send"

payload = {
    "contact_channel_id": "<string>",
    "contact_id": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "body": "<string>",
    "message": "<string>",
    "reply_to": "<string>",
    "variables": {},
    "template_ids": ["<string>"],
    "background": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contact_channel_id: '<string>',
    contact_id: '<string>',
    phone: '<string>',
    email: '<string>',
    name: '<string>',
    subject: '<string>',
    body: JSON.stringify('<string>'),
    message: '<string>',
    reply_to: '<string>',
    variables: {},
    template_ids: ['<string>'],
    background: true
  })
};

fetch('https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'contact_channel_id' => '<string>',
    'contact_id' => '<string>',
    'phone' => '<string>',
    'email' => '<string>',
    'name' => '<string>',
    'subject' => '<string>',
    'body' => '<string>',
    'message' => '<string>',
    'reply_to' => '<string>',
    'variables' => [
        
    ],
    'template_ids' => [
        '<string>'
    ],
    'background' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send"

	payload := strings.NewReader("{\n  \"contact_channel_id\": \"<string>\",\n  \"contact_id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"message\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"variables\": {},\n  \"template_ids\": [\n    \"<string>\"\n  ],\n  \"background\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact_channel_id\": \"<string>\",\n  \"contact_id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"message\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"variables\": {},\n  \"template_ids\": [\n    \"<string>\"\n  ],\n  \"background\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contact_channel_id\": \"<string>\",\n  \"contact_id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"message\": \"<string>\",\n  \"reply_to\": \"<string>\",\n  \"variables\": {},\n  \"template_ids\": [\n    \"<string>\"\n  ],\n  \"background\": true\n}"

response = http.request(request)
puts response.read_body

{
  "recipients": [
    {
      "id": "<string>",
      "broadcast_id": "<string>",
      "broadcast_name": "<string>",
      "template_id": "<string>",
      "channel_type": "internal",
      "user_id": "<string>",
      "name": "<string>",
      "username": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "status": "QUEUED",
      "source": "API",
      "payload": {},
      "retries": 123,
      "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>",
      "interactions": [
        {
          "type": "CLICK",
          "label": "<string>",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "contact": {
        "id": "<string>",
        "name": "<string>",
        "blocked": true,
        "unsubscribed": true,
        "ai_replies": true,
        "is_admin": true,
        "channels": [
          {
            "id": "<string>",
            "type": "internal",
            "user_id": "<string>",
            "avatar": "<string>",
            "name": "<string>",
            "username": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "country": "<string>",
            "agent": "<string>",
            "ip": "<string>",
            "language": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "link": "<string>"
          }
        ],
        "segments": [
          {
            "id": "<string>",
            "name": "<string>",
            "color": "red",
            "contacts_count": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "fields": {},
        "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>",
        "ai_replies_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Getting Started

Chats

Messages

Connections

Workspace

AI

Analytics and logs

Inbox

Knowledge

Assistants

Agents

Skills

Sub-organizations

Segments

Suppressions

Contacts

Custom channels

Tables

Records

Views

Pages

Broadcasts

Email sending

WhatsApp

WhatsApp Meta agent

Send transactional broadcast

Authorizations

Path Parameters

Body

Response