Skip to main content
POST
/
api
/
v2
/
motion
/
create
Create a motion
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": "",
    "additionalContext": "",
    "attachedSources": []
  },
  "description": "<string>"
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "name": "<string>",
    "offering": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>"
    },
    "data": {
      "overview": "",
      "additionalContext": "",
      "attachedSources": []
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "defaultPlaybookOId": "<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

Motion name

offeringId
string
required

Offering oId (product or service)

motionType
enum<string>
required

Motion type

Available options:
NET_NEW,
UPSELL,
CROSS_SELL,
CONVERT_FREE_TO_PAID,
RENEW_AND_RETAIN,
DISPLACE_INCUMBENT
data
object
required

Motion configuration data

description
string

Motion description

Response

200 - application/json

Created motion

_metadata
object
required
data
object
required