Create a motion playbook
curl --request POST \
--url https://app.octavehq.com/api/v2/motion-playbook/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"offeringOId": "<string>",
"narrativeInput": "<string>",
"scope": {
"allSegments": true,
"segmentOIds": [
"<string>"
],
"allPersonas": true,
"personaOIds": [
"<string>"
]
},
"anchorOverrides": {
"useCases": {
"oIds": [
"<string>"
]
},
"references": {
"oIds": [
"<string>"
]
},
"proofPoints": {
"oIds": [
"<string>"
]
},
"alternatives": {
"mode": "AUTO",
"oIds": []
},
"buyingTriggers": {
"mode": "AUTO",
"oIds": []
},
"objections": {
"mode": "AUTO",
"oIds": []
}
},
"competitorOIds": [],
"accountDomain": "<string>",
"buyingTriggerOId": "<string>",
"additionalContext": "<string>",
"additionalContextSources": [],
"brandVoiceOId": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/motion-playbook/create"
payload = {
"name": "<string>",
"offeringOId": "<string>",
"narrativeInput": "<string>",
"scope": {
"allSegments": True,
"segmentOIds": ["<string>"],
"allPersonas": True,
"personaOIds": ["<string>"]
},
"anchorOverrides": {
"useCases": { "oIds": ["<string>"] },
"references": { "oIds": ["<string>"] },
"proofPoints": { "oIds": ["<string>"] },
"alternatives": {
"mode": "AUTO",
"oIds": []
},
"buyingTriggers": {
"mode": "AUTO",
"oIds": []
},
"objections": {
"mode": "AUTO",
"oIds": []
}
},
"competitorOIds": [],
"accountDomain": "<string>",
"buyingTriggerOId": "<string>",
"additionalContext": "<string>",
"additionalContextSources": [],
"brandVoiceOId": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
offeringOId: '<string>',
narrativeInput: '<string>',
scope: {
allSegments: true,
segmentOIds: ['<string>'],
allPersonas: true,
personaOIds: ['<string>']
},
anchorOverrides: {
useCases: {oIds: ['<string>']},
references: {oIds: ['<string>']},
proofPoints: {oIds: ['<string>']},
alternatives: {mode: 'AUTO', oIds: []},
buyingTriggers: {mode: 'AUTO', oIds: []},
objections: {mode: 'AUTO', oIds: []}
},
competitorOIds: [],
accountDomain: '<string>',
buyingTriggerOId: '<string>',
additionalContext: '<string>',
additionalContextSources: [],
brandVoiceOId: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/motion-playbook/create', 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.octavehq.com/api/v2/motion-playbook/create",
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>',
'offeringOId' => '<string>',
'narrativeInput' => '<string>',
'scope' => [
'allSegments' => true,
'segmentOIds' => [
'<string>'
],
'allPersonas' => true,
'personaOIds' => [
'<string>'
]
],
'anchorOverrides' => [
'useCases' => [
'oIds' => [
'<string>'
]
],
'references' => [
'oIds' => [
'<string>'
]
],
'proofPoints' => [
'oIds' => [
'<string>'
]
],
'alternatives' => [
'mode' => 'AUTO',
'oIds' => [
]
],
'buyingTriggers' => [
'mode' => 'AUTO',
'oIds' => [
]
],
'objections' => [
'mode' => 'AUTO',
'oIds' => [
]
]
],
'competitorOIds' => [
],
'accountDomain' => '<string>',
'buyingTriggerOId' => '<string>',
'additionalContext' => '<string>',
'additionalContextSources' => [
],
'brandVoiceOId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-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.octavehq.com/api/v2/motion-playbook/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"offeringOId\": \"<string>\",\n \"narrativeInput\": \"<string>\",\n \"scope\": {\n \"allSegments\": true,\n \"segmentOIds\": [\n \"<string>\"\n ],\n \"allPersonas\": true,\n \"personaOIds\": [\n \"<string>\"\n ]\n },\n \"anchorOverrides\": {\n \"useCases\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"references\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"proofPoints\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"alternatives\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"buyingTriggers\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"objections\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n }\n },\n \"competitorOIds\": [],\n \"accountDomain\": \"<string>\",\n \"buyingTriggerOId\": \"<string>\",\n \"additionalContext\": \"<string>\",\n \"additionalContextSources\": [],\n \"brandVoiceOId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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.octavehq.com/api/v2/motion-playbook/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"offeringOId\": \"<string>\",\n \"narrativeInput\": \"<string>\",\n \"scope\": {\n \"allSegments\": true,\n \"segmentOIds\": [\n \"<string>\"\n ],\n \"allPersonas\": true,\n \"personaOIds\": [\n \"<string>\"\n ]\n },\n \"anchorOverrides\": {\n \"useCases\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"references\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"proofPoints\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"alternatives\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"buyingTriggers\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"objections\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n }\n },\n \"competitorOIds\": [],\n \"accountDomain\": \"<string>\",\n \"buyingTriggerOId\": \"<string>\",\n \"additionalContext\": \"<string>\",\n \"additionalContextSources\": [],\n \"brandVoiceOId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/motion-playbook/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"offeringOId\": \"<string>\",\n \"narrativeInput\": \"<string>\",\n \"scope\": {\n \"allSegments\": true,\n \"segmentOIds\": [\n \"<string>\"\n ],\n \"allPersonas\": true,\n \"personaOIds\": [\n \"<string>\"\n ]\n },\n \"anchorOverrides\": {\n \"useCases\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"references\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"proofPoints\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"alternatives\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"buyingTriggers\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"objections\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n }\n },\n \"competitorOIds\": [],\n \"accountDomain\": \"<string>\",\n \"buyingTriggerOId\": \"<string>\",\n \"additionalContext\": \"<string>\",\n \"additionalContextSources\": [],\n \"brandVoiceOId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"motionOId": "<string>",
"name": "<string>",
"narrativeInput": "<string>",
"competitorOIds": [
"<string>"
],
"accountDomain": "<string>",
"buyingTriggerOId": "<string>",
"motionFraming": "<string>",
"keyMessaging": [
"<string>"
],
"keyPositioning": [
"<string>"
],
"scope": {
"allSegments": true,
"segmentOIds": [
"<string>"
],
"allPersonas": true,
"personaOIds": [
"<string>"
]
},
"anchorOverrides": {
"useCases": {
"oIds": [
"<string>"
]
},
"references": {
"oIds": [
"<string>"
]
},
"proofPoints": {
"oIds": [
"<string>"
]
},
"alternatives": {
"mode": "AUTO",
"oIds": []
},
"buyingTriggers": {
"mode": "AUTO",
"oIds": []
},
"objections": {
"mode": "AUTO",
"oIds": []
}
},
"additionalContext": "<string>",
"additionalContextSources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": true
}
],
"brandVoiceOId": "<string>",
"active": true,
"lastNarrativeGeneratedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Motion Playbook
Create a motion playbook
Create a new playbook for an existing motion
POST
/
api
/
v2
/
motion-playbook
/
create
Create a motion playbook
curl --request POST \
--url https://app.octavehq.com/api/v2/motion-playbook/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"offeringOId": "<string>",
"narrativeInput": "<string>",
"scope": {
"allSegments": true,
"segmentOIds": [
"<string>"
],
"allPersonas": true,
"personaOIds": [
"<string>"
]
},
"anchorOverrides": {
"useCases": {
"oIds": [
"<string>"
]
},
"references": {
"oIds": [
"<string>"
]
},
"proofPoints": {
"oIds": [
"<string>"
]
},
"alternatives": {
"mode": "AUTO",
"oIds": []
},
"buyingTriggers": {
"mode": "AUTO",
"oIds": []
},
"objections": {
"mode": "AUTO",
"oIds": []
}
},
"competitorOIds": [],
"accountDomain": "<string>",
"buyingTriggerOId": "<string>",
"additionalContext": "<string>",
"additionalContextSources": [],
"brandVoiceOId": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/motion-playbook/create"
payload = {
"name": "<string>",
"offeringOId": "<string>",
"narrativeInput": "<string>",
"scope": {
"allSegments": True,
"segmentOIds": ["<string>"],
"allPersonas": True,
"personaOIds": ["<string>"]
},
"anchorOverrides": {
"useCases": { "oIds": ["<string>"] },
"references": { "oIds": ["<string>"] },
"proofPoints": { "oIds": ["<string>"] },
"alternatives": {
"mode": "AUTO",
"oIds": []
},
"buyingTriggers": {
"mode": "AUTO",
"oIds": []
},
"objections": {
"mode": "AUTO",
"oIds": []
}
},
"competitorOIds": [],
"accountDomain": "<string>",
"buyingTriggerOId": "<string>",
"additionalContext": "<string>",
"additionalContextSources": [],
"brandVoiceOId": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
offeringOId: '<string>',
narrativeInput: '<string>',
scope: {
allSegments: true,
segmentOIds: ['<string>'],
allPersonas: true,
personaOIds: ['<string>']
},
anchorOverrides: {
useCases: {oIds: ['<string>']},
references: {oIds: ['<string>']},
proofPoints: {oIds: ['<string>']},
alternatives: {mode: 'AUTO', oIds: []},
buyingTriggers: {mode: 'AUTO', oIds: []},
objections: {mode: 'AUTO', oIds: []}
},
competitorOIds: [],
accountDomain: '<string>',
buyingTriggerOId: '<string>',
additionalContext: '<string>',
additionalContextSources: [],
brandVoiceOId: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/motion-playbook/create', 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.octavehq.com/api/v2/motion-playbook/create",
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>',
'offeringOId' => '<string>',
'narrativeInput' => '<string>',
'scope' => [
'allSegments' => true,
'segmentOIds' => [
'<string>'
],
'allPersonas' => true,
'personaOIds' => [
'<string>'
]
],
'anchorOverrides' => [
'useCases' => [
'oIds' => [
'<string>'
]
],
'references' => [
'oIds' => [
'<string>'
]
],
'proofPoints' => [
'oIds' => [
'<string>'
]
],
'alternatives' => [
'mode' => 'AUTO',
'oIds' => [
]
],
'buyingTriggers' => [
'mode' => 'AUTO',
'oIds' => [
]
],
'objections' => [
'mode' => 'AUTO',
'oIds' => [
]
]
],
'competitorOIds' => [
],
'accountDomain' => '<string>',
'buyingTriggerOId' => '<string>',
'additionalContext' => '<string>',
'additionalContextSources' => [
],
'brandVoiceOId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-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.octavehq.com/api/v2/motion-playbook/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"offeringOId\": \"<string>\",\n \"narrativeInput\": \"<string>\",\n \"scope\": {\n \"allSegments\": true,\n \"segmentOIds\": [\n \"<string>\"\n ],\n \"allPersonas\": true,\n \"personaOIds\": [\n \"<string>\"\n ]\n },\n \"anchorOverrides\": {\n \"useCases\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"references\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"proofPoints\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"alternatives\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"buyingTriggers\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"objections\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n }\n },\n \"competitorOIds\": [],\n \"accountDomain\": \"<string>\",\n \"buyingTriggerOId\": \"<string>\",\n \"additionalContext\": \"<string>\",\n \"additionalContextSources\": [],\n \"brandVoiceOId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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.octavehq.com/api/v2/motion-playbook/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"offeringOId\": \"<string>\",\n \"narrativeInput\": \"<string>\",\n \"scope\": {\n \"allSegments\": true,\n \"segmentOIds\": [\n \"<string>\"\n ],\n \"allPersonas\": true,\n \"personaOIds\": [\n \"<string>\"\n ]\n },\n \"anchorOverrides\": {\n \"useCases\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"references\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"proofPoints\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"alternatives\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"buyingTriggers\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"objections\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n }\n },\n \"competitorOIds\": [],\n \"accountDomain\": \"<string>\",\n \"buyingTriggerOId\": \"<string>\",\n \"additionalContext\": \"<string>\",\n \"additionalContextSources\": [],\n \"brandVoiceOId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/motion-playbook/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"offeringOId\": \"<string>\",\n \"narrativeInput\": \"<string>\",\n \"scope\": {\n \"allSegments\": true,\n \"segmentOIds\": [\n \"<string>\"\n ],\n \"allPersonas\": true,\n \"personaOIds\": [\n \"<string>\"\n ]\n },\n \"anchorOverrides\": {\n \"useCases\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"references\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"proofPoints\": {\n \"oIds\": [\n \"<string>\"\n ]\n },\n \"alternatives\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"buyingTriggers\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n },\n \"objections\": {\n \"mode\": \"AUTO\",\n \"oIds\": []\n }\n },\n \"competitorOIds\": [],\n \"accountDomain\": \"<string>\",\n \"buyingTriggerOId\": \"<string>\",\n \"additionalContext\": \"<string>\",\n \"additionalContextSources\": [],\n \"brandVoiceOId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"motionOId": "<string>",
"name": "<string>",
"narrativeInput": "<string>",
"competitorOIds": [
"<string>"
],
"accountDomain": "<string>",
"buyingTriggerOId": "<string>",
"motionFraming": "<string>",
"keyMessaging": [
"<string>"
],
"keyPositioning": [
"<string>"
],
"scope": {
"allSegments": true,
"segmentOIds": [
"<string>"
],
"allPersonas": true,
"personaOIds": [
"<string>"
]
},
"anchorOverrides": {
"useCases": {
"oIds": [
"<string>"
]
},
"references": {
"oIds": [
"<string>"
]
},
"proofPoints": {
"oIds": [
"<string>"
]
},
"alternatives": {
"mode": "AUTO",
"oIds": []
},
"buyingTriggers": {
"mode": "AUTO",
"oIds": []
},
"objections": {
"mode": "AUTO",
"oIds": []
}
},
"additionalContext": "<string>",
"additionalContextSources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": true
}
],
"brandVoiceOId": "<string>",
"active": true,
"lastNarrativeGeneratedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Authorizations
Body
application/json
Minimum string length:
1Available options:
NET_NEW, UPSELL, CROSS_SELL, CONVERT_FREE_TO_PAID, RENEW_AND_RETAIN, DISPLACE_INCUMBENT Available options:
THEMATIC, MILESTONE, ACCOUNT, COMPETITIVE Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I