Skip to main content
POST
/
v1
/
messages
/
{message_id}
/
finalize
Finalize a draft
curl --request POST \
  --url https://api.relayapp.im/v1/messages/{message_id}/finalize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parts": [
    {
      "type": "text",
      "text": "Tomorrow at 2:00 PM works."
    }
  ]
}
'
import requests

url = "https://api.relayapp.im/v1/messages/{message_id}/finalize"

payload = { "parts": [
{
"type": "text",
"text": "Tomorrow at 2:00 PM works."
}
] }
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({parts: [{type: 'text', text: 'Tomorrow at 2:00 PM works.'}]})
};

fetch('https://api.relayapp.im/v1/messages/{message_id}/finalize', 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/{message_id}/finalize",
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([
'parts' => [
[
'type' => 'text',
'text' => 'Tomorrow at 2:00 PM works.'
]
]
]),
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.relayapp.im/v1/messages/{message_id}/finalize"

payload := strings.NewReader("{\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"Tomorrow at 2:00 PM works.\"\n }\n ]\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.relayapp.im/v1/messages/{message_id}/finalize")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"Tomorrow at 2:00 PM works.\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.relayapp.im/v1/messages/{message_id}/finalize")

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 \"parts\": [\n {\n \"type\": \"text\",\n \"text\": \"Tomorrow at 2:00 PM works.\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "message_id": "<string>",
  "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"
}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

message_id
string
required

Body

application/json
parts
object[]
Required array length: 1 - 32 elements

Response

The finalized canonical message.

message_id
string
message
object