Skip to main content
POST
/
api
/
v2
/
motion-playbook
/
update
Update a motion playbook
curl --request POST \
  --url https://app.octavehq.com/api/v2/motion-playbook/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "oId": "<string>",
  "name": "<string>",
  "active": true,
  "motionFraming": "<string>",
  "keyMessaging": [
    "<string>"
  ],
  "keyPositioning": [
    "<string>"
  ]
}
'
import requests

url = "https://app.octavehq.com/api/v2/motion-playbook/update"

payload = {
"oId": "<string>",
"name": "<string>",
"active": True,
"motionFraming": "<string>",
"keyMessaging": ["<string>"],
"keyPositioning": ["<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({
oId: '<string>',
name: '<string>',
active: true,
motionFraming: '<string>',
keyMessaging: ['<string>'],
keyPositioning: ['<string>']
})
};

fetch('https://app.octavehq.com/api/v2/motion-playbook/update', 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/update",
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([
'oId' => '<string>',
'name' => '<string>',
'active' => true,
'motionFraming' => '<string>',
'keyMessaging' => [
'<string>'
],
'keyPositioning' => [
'<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/update"

payload := strings.NewReader("{\n \"oId\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": true,\n \"motionFraming\": \"<string>\",\n \"keyMessaging\": [\n \"<string>\"\n ],\n \"keyPositioning\": [\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-playbook/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": true,\n \"motionFraming\": \"<string>\",\n \"keyMessaging\": [\n \"<string>\"\n ],\n \"keyPositioning\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/motion-playbook/update")

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 \"oId\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": true,\n \"motionFraming\": \"<string>\",\n \"keyMessaging\": [\n \"<string>\"\n ],\n \"keyPositioning\": [\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>",
    "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

api_key
string
header
required

Body

application/json
oId
string
required

Motion playbook oId to update

name
string

New playbook name

Minimum string length: 1
active
boolean

Set active state

motionFraming
string | null

Updated motion framing narrative

keyMessaging
string[]

Updated key messaging points

keyPositioning
string[]

Updated key positioning points

Response

200 - application/json

Updated motion playbook

_metadata
object
required
data
object
required