Create a conversation
curl --request POST \
--url https://api.custral.com/v1/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Jane Doe",
"sourceType": "imessage",
"channelId": "<string>",
"status": "open",
"participants": [
{
"recordId": "<string>",
"name": "<string>",
"email": "<string>"
}
],
"messages": [
{
"text": "On my way!",
"author": "<string>",
"authorId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.custral.com/v1/conversations"
payload = {
"title": "Jane Doe",
"sourceType": "imessage",
"channelId": "<string>",
"status": "open",
"participants": [
{
"recordId": "<string>",
"name": "<string>",
"email": "<string>"
}
],
"messages": [
{
"text": "On my way!",
"author": "<string>",
"authorId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
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({
title: 'Jane Doe',
sourceType: 'imessage',
channelId: '<string>',
status: 'open',
participants: [{recordId: '<string>', name: '<string>', email: '<string>'}],
messages: [
{
text: 'On my way!',
author: '<string>',
authorId: '<string>',
timestamp: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.custral.com/v1/conversations', 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.custral.com/v1/conversations",
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([
'title' => 'Jane Doe',
'sourceType' => 'imessage',
'channelId' => '<string>',
'status' => 'open',
'participants' => [
[
'recordId' => '<string>',
'name' => '<string>',
'email' => '<string>'
]
],
'messages' => [
[
'text' => 'On my way!',
'author' => '<string>',
'authorId' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z'
]
]
]),
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.custral.com/v1/conversations"
payload := strings.NewReader("{\n \"title\": \"Jane Doe\",\n \"sourceType\": \"imessage\",\n \"channelId\": \"<string>\",\n \"status\": \"open\",\n \"participants\": [\n {\n \"recordId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"text\": \"On my way!\",\n \"author\": \"<string>\",\n \"authorId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\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.custral.com/v1/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Jane Doe\",\n \"sourceType\": \"imessage\",\n \"channelId\": \"<string>\",\n \"status\": \"open\",\n \"participants\": [\n {\n \"recordId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"text\": \"On my way!\",\n \"author\": \"<string>\",\n \"authorId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/conversations")
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 \"title\": \"Jane Doe\",\n \"sourceType\": \"imessage\",\n \"channelId\": \"<string>\",\n \"status\": \"open\",\n \"participants\": [\n {\n \"recordId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"text\": \"On my way!\",\n \"author\": \"<string>\",\n \"authorId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "conv_123",
"title": "Jane Doe",
"status": "open",
"outcome": "won",
"summary": "<string>",
"sourceType": "imessage",
"channelId": "chan_123",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"messages": [
{
"id": "msg_123",
"text": "On my way!",
"author": "Jane Doe",
"authorId": "+15551234567",
"sourceType": "imessage",
"direction": "inbound",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"participants": [
{
"type": "record",
"name": "Jane Doe",
"email": "jane@acme.com",
"recordId": "rec_123"
}
]
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "invalid_api_key"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "insufficient_scope"
},
"reqId": "req_2a1f9c8e7b6d5"
}Conversations
Create a conversation
Create a conversation, optionally attaching participants and importing an initial transcript. Requires scope: conversations:write.
POST
/
v1
/
conversations
Create a conversation
curl --request POST \
--url https://api.custral.com/v1/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Jane Doe",
"sourceType": "imessage",
"channelId": "<string>",
"status": "open",
"participants": [
{
"recordId": "<string>",
"name": "<string>",
"email": "<string>"
}
],
"messages": [
{
"text": "On my way!",
"author": "<string>",
"authorId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.custral.com/v1/conversations"
payload = {
"title": "Jane Doe",
"sourceType": "imessage",
"channelId": "<string>",
"status": "open",
"participants": [
{
"recordId": "<string>",
"name": "<string>",
"email": "<string>"
}
],
"messages": [
{
"text": "On my way!",
"author": "<string>",
"authorId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
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({
title: 'Jane Doe',
sourceType: 'imessage',
channelId: '<string>',
status: 'open',
participants: [{recordId: '<string>', name: '<string>', email: '<string>'}],
messages: [
{
text: 'On my way!',
author: '<string>',
authorId: '<string>',
timestamp: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.custral.com/v1/conversations', 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.custral.com/v1/conversations",
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([
'title' => 'Jane Doe',
'sourceType' => 'imessage',
'channelId' => '<string>',
'status' => 'open',
'participants' => [
[
'recordId' => '<string>',
'name' => '<string>',
'email' => '<string>'
]
],
'messages' => [
[
'text' => 'On my way!',
'author' => '<string>',
'authorId' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z'
]
]
]),
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.custral.com/v1/conversations"
payload := strings.NewReader("{\n \"title\": \"Jane Doe\",\n \"sourceType\": \"imessage\",\n \"channelId\": \"<string>\",\n \"status\": \"open\",\n \"participants\": [\n {\n \"recordId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"text\": \"On my way!\",\n \"author\": \"<string>\",\n \"authorId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\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.custral.com/v1/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Jane Doe\",\n \"sourceType\": \"imessage\",\n \"channelId\": \"<string>\",\n \"status\": \"open\",\n \"participants\": [\n {\n \"recordId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"text\": \"On my way!\",\n \"author\": \"<string>\",\n \"authorId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/conversations")
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 \"title\": \"Jane Doe\",\n \"sourceType\": \"imessage\",\n \"channelId\": \"<string>\",\n \"status\": \"open\",\n \"participants\": [\n {\n \"recordId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"text\": \"On my way!\",\n \"author\": \"<string>\",\n \"authorId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "conv_123",
"title": "Jane Doe",
"status": "open",
"outcome": "won",
"summary": "<string>",
"sourceType": "imessage",
"channelId": "chan_123",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"messages": [
{
"id": "msg_123",
"text": "On my way!",
"author": "Jane Doe",
"authorId": "+15551234567",
"sourceType": "imessage",
"direction": "inbound",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"participants": [
{
"type": "record",
"name": "Jane Doe",
"email": "jane@acme.com",
"recordId": "rec_123"
}
]
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "invalid_api_key"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "insufficient_scope"
},
"reqId": "req_2a1f9c8e7b6d5"
}Authorizations
A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.
Body
application/json
The body of a create-conversation request.
Example:
"Jane Doe"
Free-form source label. Defaults to api.
Example:
"imessage"
A channel (chan_…) to attach to.
Available options:
open, closed, completed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?