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

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

payload = {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"offeringId": "<string>",
"data": {
"overview": "",
"additionalContext": "",
"attachedSources": []
}
}
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>',
description: '<string>',
offeringId: '<string>',
data: {overview: '', additionalContext: '', attachedSources: []}
})
};

fetch('https://app.octavehq.com/api/v2/motion/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/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>',
'description' => '<string>',
'offeringId' => '<string>',
'data' => [
'overview' => '',
'additionalContext' => '',
'attachedSources' => [

]
]
]),
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/update"

payload := strings.NewReader("{\n \"oId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": \"\",\n \"additionalContext\": \"\",\n \"attachedSources\": []\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/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": \"\",\n \"additionalContext\": \"\",\n \"attachedSources\": []\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/motion/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 \"description\": \"<string>\",\n \"offeringId\": \"<string>\",\n \"data\": {\n \"overview\": \"\",\n \"additionalContext\": \"\",\n \"attachedSources\": []\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>",
      "name": "<string>",
      "description": "<string>"
    },
    "data": {
      "overview": "",
      "additionalContext": "",
      "attachedSources": []
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "defaultPlaybookOId": "<string>"
  }
}

Authorizations

api_key
string
header
required

Body

application/json
oId
string
required

Motion oId to update

name
string

New name

description
string

New description

offeringId
string

New offering oId

motionType
enum<string>

New motion type

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

Updated motion data

Response

200 - application/json

Updated motion

_metadata
object
required
data
object
required