Skip to main content
POST
/
v1
/
messages
Send a message
curl --request POST \
  --url https://api.relayapp.im/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "conversation_id": "cnv_01JZC7K4RQ",
  "parts": [
    {
      "type": "text",
      "text": "Tomorrow at 2:00 PM works."
    }
  ],
  "reply_to": {
    "message_id": "msg_01JZM3T8AH",
    "part_index": 0
  },
  "draft": true
}
'
import requests

url = "https://api.relayapp.im/v1/messages"

payload = {
"conversation_id": "cnv_01JZC7K4RQ",
"parts": [
{
"type": "text",
"text": "Tomorrow at 2:00 PM works."
}
],
"reply_to": {
"message_id": "msg_01JZM3T8AH",
"part_index": 0
},
"draft": True
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
conversation_id: 'cnv_01JZC7K4RQ',
parts: [{type: 'text', text: 'Tomorrow at 2:00 PM works.'}],
reply_to: {message_id: 'msg_01JZM3T8AH', part_index: 0},
draft: true
})
};

fetch('https://api.relayapp.im/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://api.relayapp.im/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([
'conversation_id' => 'cnv_01JZC7K4RQ',
'parts' => [
[
'type' => 'text',
'text' => 'Tomorrow at 2:00 PM works.'
]
],
'reply_to' => [
'message_id' => 'msg_01JZM3T8AH',
'part_index' => 0
],
'draft' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);

$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.relayapp.im/v1/messages"

payload := strings.NewReader("{\n \"conversation_id\": \"cnv_01JZC7K4RQ\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"Tomorrow at 2:00 PM works.\"\n }\n ],\n \"reply_to\": {\n \"message_id\": \"msg_01JZM3T8AH\",\n \"part_index\": 0\n },\n \"draft\": true\n}")

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

req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.relayapp.im/v1/messages")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_id\": \"cnv_01JZC7K4RQ\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"Tomorrow at 2:00 PM works.\"\n }\n ],\n \"reply_to\": {\n \"message_id\": \"msg_01JZM3T8AH\",\n \"part_index\": 0\n },\n \"draft\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.relayapp.im/v1/messages")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversation_id\": \"cnv_01JZC7K4RQ\",\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"Tomorrow at 2:00 PM works.\"\n }\n ],\n \"reply_to\": {\n \"message_id\": \"msg_01JZM3T8AH\",\n \"part_index\": 0\n },\n \"draft\": true\n}"

response = http.request(request)
puts response.read_body
{
  "message_id": "msg_01JZM4Q9VN",
  "message": {
    "id": "msg_01JZM3T8AH",
    "conversation_id": "cnv_01JZC7K4RQ",
    "sequence": 123,
    "sender": {
      "id": "usr_01JZU1F0BD"
    },
    "parts": [
      {
        "part_index": 123,
        "text": "<string>",
        "url": "<string>",
        "attachment_id": "<string>",
        "data": {}
      }
    ],
    "fallback_text": "<string>",
    "status": "sent",
    "created_at": "2023-11-07T05:31:56Z",
    "reply_to": {
      "message_id": "msg_01JZM3T8AH",
      "part_index": 0
    }
  }
}
{
"error": {
"code": "invalid_request",
"message": "conversation_id is required"
}
}
{
"error": {
"code": "invalid_request",
"message": "conversation_id is required"
}
}
{
"error": {
"code": "invalid_request",
"message": "conversation_id is required"
}
}
{
"error": {
"code": "invalid_request",
"message": "conversation_id is required"
}
}
{
"error": {
"code": "invalid_request",
"message": "conversation_id is required"
}
}

Authorizations

Authorization
string
header
required

Agent Token (relay_agt_live_…), shown once at agent creation.

Headers

Idempotency-Key
string
required

Deriving it from the triggering event_id makes a retry safe.

Required string length: 8 - 255

Body

application/json
conversation_id
string
required

Conversation to send into, from message.received.

Example:

"cnv_01JZC7K4RQ"

parts
object[]

Ordered message parts. Required unless draft is true.

Required array length: 1 - 32 elements
reply_to
object | null
draft
boolean

Open a streaming draft; grow it with append and publish with finalize.

Response

Message accepted and committed.

message_id
string
required
Example:

"msg_01JZM4Q9VN"

message
object
required