Send a message

curl --request POST \
  --url https://{domain}/api/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "text",
  "body": "Your order has shipped.",
  "kind": "dm"
}
'

import requests

url = "https://{domain}/api/v1/messages"

payload = {
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "text",
    "body": "Your order has shipped.",
    "kind": "dm"
}
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_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'text',
    body: JSON.stringify('Your order has shipped.'),
    kind: 'dm'
  })
};

fetch('https://{domain}/api/v1/messages', 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://{domain}/api/v1/messages",
  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_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'type' => 'text',
    'body' => 'Your order has shipped.',
    'kind' => 'dm'
  ]),
  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://{domain}/api/v1/messages"

	payload := strings.NewReader("{\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"text\",\n  \"body\": \"Your order has shipped.\",\n  \"kind\": \"dm\"\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://{domain}/api/v1/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"text\",\n  \"body\": \"Your order has shipped.\",\n  \"kind\": \"dm\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v1/messages")

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_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"text\",\n  \"body\": \"Your order has shipped.\",\n  \"kind\": \"dm\"\n}"

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

Conversations & Messages

Send a message

Sends on the channel the customer last used (or the identity or channel uuid in channel), records it in the thread and fires the same message.* webhooks a dashboard reply does. Counted as a BOT send: it needs the workspace in good standing, never takes the conversation over, and gets the bot’s messaging window. Refused with 422 (with a reason) when the contact is blocked or opted out, or the window is closed — send an approved template (type: template, template_id, parameters) to re-engage. Media (while inbox media is on) is sent by reference: media.library (an id from POST /media) or media.source_message_id; a URL is refused. Send an Idempotency-Key header to make a retried request one send.

Required permission: salesbot:messages:send

POST

messages

Send a message

curl --request POST \
  --url https://{domain}/api/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "text",
  "body": "Your order has shipped.",
  "kind": "dm"
}
'

import requests

url = "https://{domain}/api/v1/messages"

payload = {
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "text",
    "body": "Your order has shipped.",
    "kind": "dm"
}
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_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'text',
    body: JSON.stringify('Your order has shipped.'),
    kind: 'dm'
  })
};

fetch('https://{domain}/api/v1/messages', 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://{domain}/api/v1/messages",
  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_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'type' => 'text',
    'body' => 'Your order has shipped.',
    'kind' => 'dm'
  ]),
  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://{domain}/api/v1/messages"

	payload := strings.NewReader("{\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"text\",\n  \"body\": \"Your order has shipped.\",\n  \"kind\": \"dm\"\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://{domain}/api/v1/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"text\",\n  \"body\": \"Your order has shipped.\",\n  \"kind\": \"dm\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v1/messages")

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_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"text\",\n  \"body\": \"Your order has shipped.\",\n  \"kind\": \"dm\"\n}"

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

Authorizations

Authorization

string

header

required

A workspace API key: Authorization: Bearer osk_...

Headers

Idempotency-Key

string

Makes a retried request a single send.

Body

application/json

contact_id

string<uuid>

type

string

Example:

"text"

body

string

Example:

"Your order has shipped."

kind

string

Example:

"dm"

Response

201

Created

Account

Automations

Broadcasts

Channels

Contacts

Conversations & Messages

Media

Segments

Tags

Send a message

Authorizations

Headers

Body

Response