Create plan
curl --request POST \
--url https://app.forecastable.com/api/v1/plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
'import requests
url = "https://app.forecastable.com/api/v1/plans"
payload = {
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
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({
entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>'
})
};
fetch('https://app.forecastable.com/api/v1/plans', 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/plans",
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([
'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>'
]),
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/plans"
payload := strings.NewReader("{\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\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/plans")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.forecastable.com/api/v1/plans")
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 \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"entityType": "OPPORTUNITY",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"opportunityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"buyingGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"milestones": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"milestone": {},
"status": "not_started",
"sortIndex": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"objective": {},
"targetDate": "2023-12-25",
"actualDate": "2023-12-25",
"prospectOwnerIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subscriberOwnerIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tasks": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"completed": true,
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"targetDate": "2023-12-25",
"assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"goals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"goalType": "MILESTONE_BASED",
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"target": 123,
"actualValue": 123,
"unitType": "NUMBER",
"label": "<string>",
"progress": 123,
"goalTypeCategory": "<string>",
"targetDate": "2023-12-25",
"periodType": "QUARTERLY",
"periodLabel": "<string>",
"allocations": {},
"parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childGoals": "<array>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"goals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"goalType": "MILESTONE_BASED",
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"target": 123,
"actualValue": 123,
"unitType": "NUMBER",
"label": "<string>",
"progress": 123,
"goalTypeCategory": "<string>",
"targetDate": "2023-12-25",
"periodType": "QUARTERLY",
"periodLabel": "<string>",
"allocations": {},
"parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childGoals": "<array>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"tasks": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"completed": true,
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"targetDate": "2023-12-25",
"assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "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": {}
}
}Plans
Create plan
Create a plan owned by an account, opportunity, buying group, or user (personal plan). For account-level plans set entityType=ACCOUNT (or omit entityType) and entityId to the account id; one active plan per account. For personal plans set entityType=USER and entityId to the owner user id. templateId is optional.
POST
/
plans
Create plan
curl --request POST \
--url https://app.forecastable.com/api/v1/plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
'import requests
url = "https://app.forecastable.com/api/v1/plans"
payload = {
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
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({
entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>'
})
};
fetch('https://app.forecastable.com/api/v1/plans', 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/plans",
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([
'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>'
]),
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/plans"
payload := strings.NewReader("{\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\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/plans")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.forecastable.com/api/v1/plans")
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 \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"entityType": "OPPORTUNITY",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"opportunityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"buyingGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"milestones": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"milestone": {},
"status": "not_started",
"sortIndex": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"objective": {},
"targetDate": "2023-12-25",
"actualDate": "2023-12-25",
"prospectOwnerIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subscriberOwnerIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tasks": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"completed": true,
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"targetDate": "2023-12-25",
"assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"goals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"goalType": "MILESTONE_BASED",
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"target": 123,
"actualValue": 123,
"unitType": "NUMBER",
"label": "<string>",
"progress": 123,
"goalTypeCategory": "<string>",
"targetDate": "2023-12-25",
"periodType": "QUARTERLY",
"periodLabel": "<string>",
"allocations": {},
"parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childGoals": "<array>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"goals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"goalType": "MILESTONE_BASED",
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"target": 123,
"actualValue": 123,
"unitType": "NUMBER",
"label": "<string>",
"progress": 123,
"goalTypeCategory": "<string>",
"targetDate": "2023-12-25",
"periodType": "QUARTERLY",
"periodLabel": "<string>",
"allocations": {},
"parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childGoals": "<array>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"tasks": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"completed": true,
"createdAt": "2023-11-07T05:31:56Z",
"milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"targetDate": "2023-12-25",
"assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "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.
FlowAuthorization Code
- Authorization URL
- /api/v1/oauth/authorize
- Token URL
- /api/v1/oauth/token
FlowClient Credentials
- Token URL
- /api/v1/oauth/token
Scopes1
plans:write
Create and update partner plans.
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
Entity that owns the plan. For account-level plans pass the account id (entityType=ACCOUNT, or omit entityType). For personal plans set entityType=USER and entityId to the owner user id.
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}$Required string length:
1 - 120Plan owner type. ACCOUNT is an account-level plan owned by the account itself (one active plan per account). BUYING_GROUP and OPPORTUNITY plans hang off those entities. USER is a personal ("My Plan") plan owned by a user in the organization.
Available options:
OPPORTUNITY, BUYING_GROUP, USER, ACCOUNT 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 string length:
32000Response
Created plan.
Show child attributes
Show child attributes
Was this page helpful?