Skip to main content
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>"
}
'
{
  "_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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Body

application/json
name
string
required
Minimum string length: 1
motionType
enum<string>
required
Available options:
NET_NEW,
UPSELL,
CROSS_SELL,
CONVERT_FREE_TO_PAID,
RENEW_AND_RETAIN,
DISPLACE_INCUMBENT
offeringOId
string
required
narrativeType
enum<string>
required
Available options:
THEMATIC,
MILESTONE,
ACCOUNT,
COMPETITIVE
narrativeInput
string
required
Minimum string length: 1
scope
object
required
anchorOverrides
object
required
competitorOIds
string[]
accountDomain
string | null
buyingTriggerOId
string | null
additionalContext
string | null
additionalContextSources
object[]
brandVoiceOId
string | null

Response

200 - application/json

Created motion playbook

_metadata
object
required
data
object
required