Create Engage template
curl --request POST \
--url https://app.forecastable.com/api/v1/engage/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"subject": "<string>",
"body": "<string>",
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"isPublic": true,
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountTypes": [
"<string>"
],
"accountStatuses": [
"<string>"
],
"persona": [
"<string>"
],
"scheduling": {},
"bookingLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://app.forecastable.com/api/v1/engage/templates"
payload = {
"name": "<string>",
"subject": "<string>",
"body": "<string>",
"cc": ["<string>"],
"bcc": ["<string>"],
"isPublic": True,
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountTypes": ["<string>"],
"accountStatuses": ["<string>"],
"persona": ["<string>"],
"scheduling": {},
"bookingLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
name: '<string>',
subject: '<string>',
body: JSON.stringify('<string>'),
cc: ['<string>'],
bcc: ['<string>'],
isPublic: true,
accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountTypes: ['<string>'],
accountStatuses: ['<string>'],
persona: ['<string>'],
scheduling: {},
bookingLinkId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ownerUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://app.forecastable.com/api/v1/engage/templates', 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/templates",
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([
'name' => '<string>',
'subject' => '<string>',
'body' => '<string>',
'cc' => [
'<string>'
],
'bcc' => [
'<string>'
],
'isPublic' => true,
'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountTypes' => [
'<string>'
],
'accountStatuses' => [
'<string>'
],
'persona' => [
'<string>'
],
'scheduling' => [
],
'bookingLinkId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ownerUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://app.forecastable.com/api/v1/engage/templates"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountTypes\": [\n \"<string>\"\n ],\n \"accountStatuses\": [\n \"<string>\"\n ],\n \"persona\": [\n \"<string>\"\n ],\n \"scheduling\": {},\n \"bookingLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ownerUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://app.forecastable.com/api/v1/engage/templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountTypes\": [\n \"<string>\"\n ],\n \"accountStatuses\": [\n \"<string>\"\n ],\n \"persona\": [\n \"<string>\"\n ],\n \"scheduling\": {},\n \"bookingLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ownerUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.forecastable.com/api/v1/engage/templates")
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 \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountTypes\": [\n \"<string>\"\n ],\n \"accountStatuses\": [\n \"<string>\"\n ],\n \"persona\": [\n \"<string>\"\n ],\n \"scheduling\": {},\n \"bookingLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ownerUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"templateType": "email",
"isPublic": true,
"isArchived": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"body": "<string>",
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountTypes": [
"<string>"
],
"accountStatuses": [
"<string>"
],
"persona": [
"<string>"
],
"scheduling": {},
"bookingLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileName": "<string>",
"mimeType": "<string>",
"byteSize": 123,
"assetUrl": "<string>"
}
],
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"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 Templates
Create Engage template
Create an Engage template. Does not send mail. Pass ownerUserId from listOrganizationUsers to own it as that org user; without it, ownership is the authenticated user (who may not be a member of the active org).
POST
/
engage
/
templates
Create Engage template
curl --request POST \
--url https://app.forecastable.com/api/v1/engage/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"subject": "<string>",
"body": "<string>",
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"isPublic": true,
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountTypes": [
"<string>"
],
"accountStatuses": [
"<string>"
],
"persona": [
"<string>"
],
"scheduling": {},
"bookingLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://app.forecastable.com/api/v1/engage/templates"
payload = {
"name": "<string>",
"subject": "<string>",
"body": "<string>",
"cc": ["<string>"],
"bcc": ["<string>"],
"isPublic": True,
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountTypes": ["<string>"],
"accountStatuses": ["<string>"],
"persona": ["<string>"],
"scheduling": {},
"bookingLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
name: '<string>',
subject: '<string>',
body: JSON.stringify('<string>'),
cc: ['<string>'],
bcc: ['<string>'],
isPublic: true,
accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountTypes: ['<string>'],
accountStatuses: ['<string>'],
persona: ['<string>'],
scheduling: {},
bookingLinkId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ownerUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://app.forecastable.com/api/v1/engage/templates', 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/templates",
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([
'name' => '<string>',
'subject' => '<string>',
'body' => '<string>',
'cc' => [
'<string>'
],
'bcc' => [
'<string>'
],
'isPublic' => true,
'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountTypes' => [
'<string>'
],
'accountStatuses' => [
'<string>'
],
'persona' => [
'<string>'
],
'scheduling' => [
],
'bookingLinkId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ownerUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://app.forecastable.com/api/v1/engage/templates"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountTypes\": [\n \"<string>\"\n ],\n \"accountStatuses\": [\n \"<string>\"\n ],\n \"persona\": [\n \"<string>\"\n ],\n \"scheduling\": {},\n \"bookingLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ownerUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://app.forecastable.com/api/v1/engage/templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountTypes\": [\n \"<string>\"\n ],\n \"accountStatuses\": [\n \"<string>\"\n ],\n \"persona\": [\n \"<string>\"\n ],\n \"scheduling\": {},\n \"bookingLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ownerUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.forecastable.com/api/v1/engage/templates")
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 \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountTypes\": [\n \"<string>\"\n ],\n \"accountStatuses\": [\n \"<string>\"\n ],\n \"persona\": [\n \"<string>\"\n ],\n \"scheduling\": {},\n \"bookingLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ownerUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"template": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"templateType": "email",
"isPublic": true,
"isArchived": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"body": "<string>",
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountTypes": [
"<string>"
],
"accountStatuses": [
"<string>"
],
"persona": [
"<string>"
],
"scheduling": {},
"bookingLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileName": "<string>",
"mimeType": "<string>",
"byteSize": 123,
"assetUrl": "<string>"
}
],
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"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.
FlowAuthorization Code
- Authorization URL
- /api/v1/oauth/authorize
- Token URL
- /api/v1/oauth/token
FlowClient Credentials
- Token URL
- /api/v1/oauth/token
Scopes1
engage.templates:write
Create and update engagement templates.
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}$Query 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
Required string length:
1 - 300Available options:
email, linkedin, slack Maximum string length:
998Maximum string length:
500000Pattern:
^[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}$One of the owner's booking links, rendered for {{booking_link}}. Required when the subject or body uses {{booking_link}} and the owner has more than one booking link; a single booking link is selected automatically.
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}$Organization user that owns the template. Resolve from listOrganizationUsers in the active org. Required for client-credential tokens and whenever the authenticated user is not a member of the active organization; otherwise user tokens default to themselves.
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}$Response
Created template.
Show child attributes
Show child attributes
Was this page helpful?