curl --request POST \
--url https://app.octavehq.com/api/v2/motion/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"offeringId": "<string>",
"data": {
"overview": [],
"scope": [],
"additionalContext": "",
"attachedSources": [],
"additionalProperties": {},
"guidingNotes": {}
},
"description": "<string>",
"srcOfferingId": "<string>",
"competitorOId": "<string>",
"coreFeatureOIds": [
"<string>"
],
"excludedPersonaOIds": [
"<string>"
],
"excludedSegmentOIds": [
"<string>"
]
}
'import requests
url = "https://app.octavehq.com/api/v2/motion/create"
payload = {
"name": "<string>",
"offeringId": "<string>",
"data": {
"overview": [],
"scope": [],
"additionalContext": "",
"attachedSources": [],
"additionalProperties": {},
"guidingNotes": {}
},
"description": "<string>",
"srcOfferingId": "<string>",
"competitorOId": "<string>",
"coreFeatureOIds": ["<string>"],
"excludedPersonaOIds": ["<string>"],
"excludedSegmentOIds": ["<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>',
offeringId: '<string>',
data: {
overview: [],
scope: [],
additionalContext: '',
attachedSources: [],
additionalProperties: {},
guidingNotes: {}
},
description: '<string>',
srcOfferingId: '<string>',
competitorOId: '<string>',
coreFeatureOIds: ['<string>'],
excludedPersonaOIds: ['<string>'],
excludedSegmentOIds: ['<string>']
})
};
fetch('https://app.octavehq.com/api/v2/motion/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/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>',
'offeringId' => '<string>',
'data' => [
'overview' => [
],
'scope' => [
],
'additionalContext' => '',
'attachedSources' => [
],
'additionalProperties' => [
],
'guidingNotes' => [
]
],
'description' => '<string>',
'srcOfferingId' => '<string>',
'competitorOId' => '<string>',
'coreFeatureOIds' => [
'<string>'
],
'excludedPersonaOIds' => [
'<string>'
],
'excludedSegmentOIds' => [
'<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/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": [],\n \"scope\": [],\n \"additionalContext\": \"\",\n \"attachedSources\": [],\n \"additionalProperties\": {},\n \"guidingNotes\": {}\n },\n \"description\": \"<string>\",\n \"srcOfferingId\": \"<string>\",\n \"competitorOId\": \"<string>\",\n \"coreFeatureOIds\": [\n \"<string>\"\n ],\n \"excludedPersonaOIds\": [\n \"<string>\"\n ],\n \"excludedSegmentOIds\": [\n \"<string>\"\n ]\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/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": [],\n \"scope\": [],\n \"additionalContext\": \"\",\n \"attachedSources\": [],\n \"additionalProperties\": {},\n \"guidingNotes\": {}\n },\n \"description\": \"<string>\",\n \"srcOfferingId\": \"<string>\",\n \"competitorOId\": \"<string>\",\n \"coreFeatureOIds\": [\n \"<string>\"\n ],\n \"excludedPersonaOIds\": [\n \"<string>\"\n ],\n \"excludedSegmentOIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/motion/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 \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": [],\n \"scope\": [],\n \"additionalContext\": \"\",\n \"attachedSources\": [],\n \"additionalProperties\": {},\n \"guidingNotes\": {}\n },\n \"description\": \"<string>\",\n \"srcOfferingId\": \"<string>\",\n \"competitorOId\": \"<string>\",\n \"coreFeatureOIds\": [\n \"<string>\"\n ],\n \"excludedPersonaOIds\": [\n \"<string>\"\n ],\n \"excludedSegmentOIds\": [\n \"<string>\"\n ]\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>",
"name": "<string>",
"offering": {
"oId": "<string>",
"type": "PRODUCT",
"name": "<string>",
"description": "<string>"
},
"motionType": "NET_NEW",
"data": {
"overview": [],
"scope": [],
"additionalContext": "",
"attachedSources": [],
"additionalProperties": {},
"guidingNotes": {},
"icpExclusions": {
"personaOIds": [],
"segmentOIds": []
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"srcOffering": {
"oId": "<string>",
"type": "PRODUCT",
"name": "<string>",
"description": "<string>"
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>"
},
"coreFeatures": [],
"defaultPlaybookOId": "<string>",
"createdByUserOId": "<string>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Create a motion
Create a new motion with a default playbook. The offering must pass motion eligibility (status ELIGIBLE). Returns 400 when status is INELIGIBLE or LIBRARY_ADJUSTMENT_REQUIRED.
curl --request POST \
--url https://app.octavehq.com/api/v2/motion/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"offeringId": "<string>",
"data": {
"overview": [],
"scope": [],
"additionalContext": "",
"attachedSources": [],
"additionalProperties": {},
"guidingNotes": {}
},
"description": "<string>",
"srcOfferingId": "<string>",
"competitorOId": "<string>",
"coreFeatureOIds": [
"<string>"
],
"excludedPersonaOIds": [
"<string>"
],
"excludedSegmentOIds": [
"<string>"
]
}
'import requests
url = "https://app.octavehq.com/api/v2/motion/create"
payload = {
"name": "<string>",
"offeringId": "<string>",
"data": {
"overview": [],
"scope": [],
"additionalContext": "",
"attachedSources": [],
"additionalProperties": {},
"guidingNotes": {}
},
"description": "<string>",
"srcOfferingId": "<string>",
"competitorOId": "<string>",
"coreFeatureOIds": ["<string>"],
"excludedPersonaOIds": ["<string>"],
"excludedSegmentOIds": ["<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>',
offeringId: '<string>',
data: {
overview: [],
scope: [],
additionalContext: '',
attachedSources: [],
additionalProperties: {},
guidingNotes: {}
},
description: '<string>',
srcOfferingId: '<string>',
competitorOId: '<string>',
coreFeatureOIds: ['<string>'],
excludedPersonaOIds: ['<string>'],
excludedSegmentOIds: ['<string>']
})
};
fetch('https://app.octavehq.com/api/v2/motion/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/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>',
'offeringId' => '<string>',
'data' => [
'overview' => [
],
'scope' => [
],
'additionalContext' => '',
'attachedSources' => [
],
'additionalProperties' => [
],
'guidingNotes' => [
]
],
'description' => '<string>',
'srcOfferingId' => '<string>',
'competitorOId' => '<string>',
'coreFeatureOIds' => [
'<string>'
],
'excludedPersonaOIds' => [
'<string>'
],
'excludedSegmentOIds' => [
'<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/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": [],\n \"scope\": [],\n \"additionalContext\": \"\",\n \"attachedSources\": [],\n \"additionalProperties\": {},\n \"guidingNotes\": {}\n },\n \"description\": \"<string>\",\n \"srcOfferingId\": \"<string>\",\n \"competitorOId\": \"<string>\",\n \"coreFeatureOIds\": [\n \"<string>\"\n ],\n \"excludedPersonaOIds\": [\n \"<string>\"\n ],\n \"excludedSegmentOIds\": [\n \"<string>\"\n ]\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/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": [],\n \"scope\": [],\n \"additionalContext\": \"\",\n \"attachedSources\": [],\n \"additionalProperties\": {},\n \"guidingNotes\": {}\n },\n \"description\": \"<string>\",\n \"srcOfferingId\": \"<string>\",\n \"competitorOId\": \"<string>\",\n \"coreFeatureOIds\": [\n \"<string>\"\n ],\n \"excludedPersonaOIds\": [\n \"<string>\"\n ],\n \"excludedSegmentOIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/motion/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 \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": [],\n \"scope\": [],\n \"additionalContext\": \"\",\n \"attachedSources\": [],\n \"additionalProperties\": {},\n \"guidingNotes\": {}\n },\n \"description\": \"<string>\",\n \"srcOfferingId\": \"<string>\",\n \"competitorOId\": \"<string>\",\n \"coreFeatureOIds\": [\n \"<string>\"\n ],\n \"excludedPersonaOIds\": [\n \"<string>\"\n ],\n \"excludedSegmentOIds\": [\n \"<string>\"\n ]\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>",
"name": "<string>",
"offering": {
"oId": "<string>",
"type": "PRODUCT",
"name": "<string>",
"description": "<string>"
},
"motionType": "NET_NEW",
"data": {
"overview": [],
"scope": [],
"additionalContext": "",
"attachedSources": [],
"additionalProperties": {},
"guidingNotes": {},
"icpExclusions": {
"personaOIds": [],
"segmentOIds": []
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"srcOffering": {
"oId": "<string>",
"type": "PRODUCT",
"name": "<string>",
"description": "<string>"
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>"
},
"coreFeatures": [],
"defaultPlaybookOId": "<string>",
"createdByUserOId": "<string>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
Motion name
Offering oId (product or service)
Motion type
NET_NEW, UPSELL, CROSS_SELL, CONVERT_FREE_TO_PAID, RENEW_AND_RETAIN, DISPLACE_INCUMBENT Motion configuration data. Target-ICP exclusions are set via the top-level excludedPersonaOIds/excludedSegmentOIds fields, not here.
Show child attributes
Show child attributes
Motion description
Optional source/FROM offering oId (cross-sell, convert-free-to-paid).
Optional competitor oId being displaced (displace-incumbent).
Optional core-feature oIds to emphasize.
Persona oIds to exclude from the motion's target ICP. Excluded personas still get matrix cells, but disabled. Must be linked to the offering.
1000Segment oIds to exclude from the motion's target ICP. Excluded segments still get matrix cells, but disabled. Must be linked to the offering.
1000