Skip to main content
POST
/
api
/
v2
/
alternative
/
update
Update Alternative
curl --request POST \
  --url https://app.octavehq.com/api/v2/alternative/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "oId": "ao_1234",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "whereItWorks": [
    "<string>"
  ],
  "whereItBreaks": [
    "<string>"
  ],
  "whoChampionsThisApproach": [
    "<string>"
  ],
  "whyOurApproachIsSuperior": [
    "<string>"
  ],
  "perceivedBenefits": [
    "<string>"
  ],
  "hiddenCostsAndPitfalls": [
    "<string>"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}
'
import requests

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

payload = {
    "oId": "ao_1234",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "whereItWorks": ["<string>"],
    "whereItBreaks": ["<string>"],
    "whoChampionsThisApproach": ["<string>"],
    "whyOurApproachIsSuperior": ["<string>"],
    "perceivedBenefits": ["<string>"],
    "hiddenCostsAndPitfalls": ["<string>"],
    "customFields": [
        {
            "title": "<string>",
            "value": ["<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: 'ao_1234',
    name: '<string>',
    internalName: '<string>',
    description: '<string>',
    whereItWorks: ['<string>'],
    whereItBreaks: ['<string>'],
    whoChampionsThisApproach: ['<string>'],
    whyOurApproachIsSuperior: ['<string>'],
    perceivedBenefits: ['<string>'],
    hiddenCostsAndPitfalls: ['<string>'],
    customFields: [{title: '<string>', value: ['<string>']}]
  })
};

fetch('https://app.octavehq.com/api/v2/alternative/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/alternative/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' => 'ao_1234',
    'name' => '<string>',
    'internalName' => '<string>',
    'description' => '<string>',
    'whereItWorks' => [
        '<string>'
    ],
    'whereItBreaks' => [
        '<string>'
    ],
    'whoChampionsThisApproach' => [
        '<string>'
    ],
    'whyOurApproachIsSuperior' => [
        '<string>'
    ],
    'perceivedBenefits' => [
        '<string>'
    ],
    'hiddenCostsAndPitfalls' => [
        '<string>'
    ],
    'customFields' => [
        [
                'title' => '<string>',
                'value' => [
                                '<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/alternative/update"

	payload := strings.NewReader("{\n  \"oId\": \"ao_1234\",\n  \"name\": \"<string>\",\n  \"internalName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"whereItWorks\": [\n    \"<string>\"\n  ],\n  \"whereItBreaks\": [\n    \"<string>\"\n  ],\n  \"whoChampionsThisApproach\": [\n    \"<string>\"\n  ],\n  \"whyOurApproachIsSuperior\": [\n    \"<string>\"\n  ],\n  \"perceivedBenefits\": [\n    \"<string>\"\n  ],\n  \"hiddenCostsAndPitfalls\": [\n    \"<string>\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\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/alternative/update")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"oId\": \"ao_1234\",\n  \"name\": \"<string>\",\n  \"internalName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"whereItWorks\": [\n    \"<string>\"\n  ],\n  \"whereItBreaks\": [\n    \"<string>\"\n  ],\n  \"whoChampionsThisApproach\": [\n    \"<string>\"\n  ],\n  \"whyOurApproachIsSuperior\": [\n    \"<string>\"\n  ],\n  \"perceivedBenefits\": [\n    \"<string>\"\n  ],\n  \"hiddenCostsAndPitfalls\": [\n    \"<string>\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/alternative/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\": \"ao_1234\",\n  \"name\": \"<string>\",\n  \"internalName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"whereItWorks\": [\n    \"<string>\"\n  ],\n  \"whereItBreaks\": [\n    \"<string>\"\n  ],\n  \"whoChampionsThisApproach\": [\n    \"<string>\"\n  ],\n  \"whyOurApproachIsSuperior\": [\n    \"<string>\"\n  ],\n  \"perceivedBenefits\": [\n    \"<string>\"\n  ],\n  \"hiddenCostsAndPitfalls\": [\n    \"<string>\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\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>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "active": true,
    "data": {
      "whereItWorks": [
        "<string>"
      ],
      "whereItBreaks": [
        "<string>"
      ],
      "whoChampionsThisApproach": [
        "<string>"
      ],
      "whyOurApproachIsSuperior": [
        "<string>"
      ],
      "perceivedBenefits": [
        "<string>"
      ],
      "hiddenCostsAndPitfalls": [
        "<string>"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "<string>"
    }
  }
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}

Authorizations

api_key
string
header
required

Body

application/json

Alternative update input

oId
string
required

The ID of the alternative to update

Minimum string length: 1
Example:

"ao_1234"

name
string

The name of the alternative

internalName
string

The internal name of the alternative

description
string

A description of the alternative

whereItWorks
string[]
whereItBreaks
string[]
whoChampionsThisApproach
string[]
whyOurApproachIsSuperior
string[]
perceivedBenefits
string[]
hiddenCostsAndPitfalls
string[]
customFields
object[]

Custom fields for additional alternative information

Response

Alternative updated successfully

_metadata
object
required
data
object
required