Send Engage message (REST only)
curl --request POST \
--url https://app.forecastable.com/api/v1/engage/messages/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"source": {
"type": "oneOff",
"body": "<string>",
"subject": "<string>"
},
"sendIndividually": true,
"senderUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"cc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"bcc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"engageListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendAt": "2023-11-07T05:31:56Z",
"needsApproval": true,
"trackingOptions": {
"opens": true,
"links": true,
"threadReplies": true
},
"simulate": true
}
'import requests
url = "https://app.forecastable.com/api/v1/engage/messages/send"
payload = {
"source": {
"type": "oneOff",
"body": "<string>",
"subject": "<string>"
},
"sendIndividually": True,
"senderUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"cc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"bcc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"engageListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendAt": "2023-11-07T05:31:56Z",
"needsApproval": True,
"trackingOptions": {
"opens": True,
"links": True,
"threadReplies": True
},
"simulate": 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({
source: {type: 'oneOff', body: JSON.stringify('<string>'), subject: '<string>'},
sendIndividually: true,
senderUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
to: [
{
email: '<string>',
name: '<string>',
contactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
linkedinUrl: '<string>',
slackUserId: '<string>'
}
],
cc: [
{
email: '<string>',
name: '<string>',
contactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
linkedinUrl: '<string>',
slackUserId: '<string>'
}
],
bcc: [
{
email: '<string>',
name: '<string>',
contactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
linkedinUrl: '<string>',
slackUserId: '<string>'
}
],
engageListId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sendAt: '2023-11-07T05:31:56Z',
needsApproval: true,
trackingOptions: {opens: true, links: true, threadReplies: true},
simulate: true
})
};
fetch('https://app.forecastable.com/api/v1/engage/messages/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://app.forecastable.com/api/v1/engage/messages/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([
'source' => [
'type' => 'oneOff',
'body' => '<string>',
'subject' => '<string>'
],
'sendIndividually' => true,
'senderUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'to' => [
[
'email' => '<string>',
'name' => '<string>',
'contactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'linkedinUrl' => '<string>',
'slackUserId' => '<string>'
]
],
'cc' => [
[
'email' => '<string>',
'name' => '<string>',
'contactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'linkedinUrl' => '<string>',
'slackUserId' => '<string>'
]
],
'bcc' => [
[
'email' => '<string>',
'name' => '<string>',
'contactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'linkedinUrl' => '<string>',
'slackUserId' => '<string>'
]
],
'engageListId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sendAt' => '2023-11-07T05:31:56Z',
'needsApproval' => true,
'trackingOptions' => [
'opens' => true,
'links' => true,
'threadReplies' => true
],
'simulate' => 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://app.forecastable.com/api/v1/engage/messages/send"
payload := strings.NewReader("{\n \"source\": {\n \"type\": \"oneOff\",\n \"body\": \"<string>\",\n \"subject\": \"<string>\"\n },\n \"sendIndividually\": true,\n \"senderUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"engageListId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"needsApproval\": true,\n \"trackingOptions\": {\n \"opens\": true,\n \"links\": true,\n \"threadReplies\": true\n },\n \"simulate\": 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://app.forecastable.com/api/v1/engage/messages/send")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"type\": \"oneOff\",\n \"body\": \"<string>\",\n \"subject\": \"<string>\"\n },\n \"sendIndividually\": true,\n \"senderUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"engageListId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"needsApproval\": true,\n \"trackingOptions\": {\n \"opens\": true,\n \"links\": true,\n \"threadReplies\": true\n },\n \"simulate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.forecastable.com/api/v1/engage/messages/send")
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 \"source\": {\n \"type\": \"oneOff\",\n \"body\": \"<string>\",\n \"subject\": \"<string>\"\n },\n \"sendIndividually\": true,\n \"senderUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"engageListId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"needsApproval\": true,\n \"trackingOptions\": {\n \"opens\": true,\n \"links\": true,\n \"threadReplies\": true\n },\n \"simulate\": true\n}"
response = http.request(request)
puts response.read_body{
"queueIds": [
"<string>"
],
"simulated": true,
"scheduledAt": "2023-11-07T05:31:56Z"
}{
"queueIds": [
"<string>"
],
"simulated": true,
"scheduledAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Engage Messaging
Send Engage message (REST only)
Unified multi-channel send with a discriminated source union (oneOff, template, draft) and a required sendIndividually flag. sendIndividually: true delivers one personalized message per recipient (all merge variables supported; recipients never see each other; cc/bcc require a single recipient). sendIndividually: false delivers a single email with every recipient together on the To line (email channel only; cc/bcc allowed): recipient-personalized variables (, , ) are rejected with 422, while account and sender variables remain available. Requires an Idempotency-Key header. Returns 200 only after an immediate provider send; returns 202 with queue IDs for scheduled, worker-queued, or approval-pending sends. This operation is intentionally not exposed as an MCP tool.
POST
/
engage
/
messages
/
send
Send Engage message (REST only)
curl --request POST \
--url https://app.forecastable.com/api/v1/engage/messages/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"source": {
"type": "oneOff",
"body": "<string>",
"subject": "<string>"
},
"sendIndividually": true,
"senderUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"cc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"bcc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"engageListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendAt": "2023-11-07T05:31:56Z",
"needsApproval": true,
"trackingOptions": {
"opens": true,
"links": true,
"threadReplies": true
},
"simulate": true
}
'import requests
url = "https://app.forecastable.com/api/v1/engage/messages/send"
payload = {
"source": {
"type": "oneOff",
"body": "<string>",
"subject": "<string>"
},
"sendIndividually": True,
"senderUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"cc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"bcc": [
{
"email": "<string>",
"name": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"linkedinUrl": "<string>",
"slackUserId": "<string>"
}
],
"engageListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendAt": "2023-11-07T05:31:56Z",
"needsApproval": True,
"trackingOptions": {
"opens": True,
"links": True,
"threadReplies": True
},
"simulate": 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({
source: {type: 'oneOff', body: JSON.stringify('<string>'), subject: '<string>'},
sendIndividually: true,
senderUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
to: [
{
email: '<string>',
name: '<string>',
contactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
linkedinUrl: '<string>',
slackUserId: '<string>'
}
],
cc: [
{
email: '<string>',
name: '<string>',
contactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
linkedinUrl: '<string>',
slackUserId: '<string>'
}
],
bcc: [
{
email: '<string>',
name: '<string>',
contactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
linkedinUrl: '<string>',
slackUserId: '<string>'
}
],
engageListId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sendAt: '2023-11-07T05:31:56Z',
needsApproval: true,
trackingOptions: {opens: true, links: true, threadReplies: true},
simulate: true
})
};
fetch('https://app.forecastable.com/api/v1/engage/messages/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://app.forecastable.com/api/v1/engage/messages/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([
'source' => [
'type' => 'oneOff',
'body' => '<string>',
'subject' => '<string>'
],
'sendIndividually' => true,
'senderUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'to' => [
[
'email' => '<string>',
'name' => '<string>',
'contactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'linkedinUrl' => '<string>',
'slackUserId' => '<string>'
]
],
'cc' => [
[
'email' => '<string>',
'name' => '<string>',
'contactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'linkedinUrl' => '<string>',
'slackUserId' => '<string>'
]
],
'bcc' => [
[
'email' => '<string>',
'name' => '<string>',
'contactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'linkedinUrl' => '<string>',
'slackUserId' => '<string>'
]
],
'engageListId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sendAt' => '2023-11-07T05:31:56Z',
'needsApproval' => true,
'trackingOptions' => [
'opens' => true,
'links' => true,
'threadReplies' => true
],
'simulate' => 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://app.forecastable.com/api/v1/engage/messages/send"
payload := strings.NewReader("{\n \"source\": {\n \"type\": \"oneOff\",\n \"body\": \"<string>\",\n \"subject\": \"<string>\"\n },\n \"sendIndividually\": true,\n \"senderUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"engageListId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"needsApproval\": true,\n \"trackingOptions\": {\n \"opens\": true,\n \"links\": true,\n \"threadReplies\": true\n },\n \"simulate\": 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://app.forecastable.com/api/v1/engage/messages/send")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"type\": \"oneOff\",\n \"body\": \"<string>\",\n \"subject\": \"<string>\"\n },\n \"sendIndividually\": true,\n \"senderUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"engageListId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"needsApproval\": true,\n \"trackingOptions\": {\n \"opens\": true,\n \"links\": true,\n \"threadReplies\": true\n },\n \"simulate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.forecastable.com/api/v1/engage/messages/send")
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 \"source\": {\n \"type\": \"oneOff\",\n \"body\": \"<string>\",\n \"subject\": \"<string>\"\n },\n \"sendIndividually\": true,\n \"senderUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"contactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"linkedinUrl\": \"<string>\",\n \"slackUserId\": \"<string>\"\n }\n ],\n \"engageListId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sendAt\": \"2023-11-07T05:31:56Z\",\n \"needsApproval\": true,\n \"trackingOptions\": {\n \"opens\": true,\n \"links\": true,\n \"threadReplies\": true\n },\n \"simulate\": true\n}"
response = http.request(request)
puts response.read_body{
"queueIds": [
"<string>"
],
"simulated": true,
"scheduledAt": "2023-11-07T05:31:56Z"
}{
"queueIds": [
"<string>"
],
"simulated": true,
"scheduledAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Partner OAuth2 flows for integration API access tokens. Claude MCP custom connectors use authorization code with PKCE S256.
Headers
Active organization UUID. Required for authenticated requests when the principal has access to multiple organizations.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Unique client-generated key for safe retries. Replaying the same key with the same payload returns the stored result; reuse with a different payload returns 409.
Required string length:
1 - 255Query Parameters
Read-only convenience alias for X-Organization-Id. Legacy subscriberId query param is also accepted.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Body
application/json
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Required. true sends one personalized message per recipient: all merge variables are supported, recipients never see each other, and cc/bcc require a single recipient. false sends one email with every recipient together on the To line (email channel only; cc/bcc allowed for any recipient count): recipient-personalized variables ({{first_name}}, {{last_name}}, {{full_name}}) are rejected with 422 because all recipients share one body, while account and sender variables such as {{account_name}} and {{sender_first_name}} remain available.
Organization user to send as. Required for client-credential tokens; user tokens default to the authenticated user.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Maximum array length:
100Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Show child attributes
Show child attributes
Validate and render the send without performing any outbound provider call or writing queue rows.
Was this page helpful?
⌘I