Skip to main content
POST
/
api
/
v2
/
solution
/
update
Update Solution
curl --request POST \
  --url https://app.octavehq.com/api/v2/solution/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "oId": "<string>",
  "data": {
    "updatedAt": "<string>",
    "archivedAt": "<string>",
    "deletedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "primaryUrl": "<string>",
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "<string>"
      }
    ],
    "data": {
      "internalName": "<string>",
      "summary": "<string>",
      "distinctCapabilities": [],
      "keyComponents": [],
      "customerBenefits": [],
      "challengesAddressed": [],
      "statusQuo": [],
      "differentiatedValue": [],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    }
  }
}
'
import requests

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

payload = {
"oId": "<string>",
"data": {
"updatedAt": "<string>",
"archivedAt": "<string>",
"deletedAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"primaryUrl": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"data": {
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [],
"keyComponents": [],
"customerBenefits": [],
"challengesAddressed": [],
"statusQuo": [],
"differentiatedValue": [],
"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: '<string>',
data: {
updatedAt: '<string>',
archivedAt: '<string>',
deletedAt: '<string>',
name: '<string>',
internalName: '<string>',
description: '<string>',
primaryUrl: '<string>',
qualifyingQuestions: [
{
question: '<string>',
rationale: '<string>',
fitType: 'GOOD',
weight: 'MEDIUM',
archivedAt: '<string>'
}
],
data: {
internalName: '<string>',
summary: '<string>',
distinctCapabilities: [],
keyComponents: [],
customerBenefits: [],
challengesAddressed: [],
statusQuo: [],
differentiatedValue: [],
customFields: [{title: '<string>', value: ['<string>']}]
}
}
})
};

fetch('https://app.octavehq.com/api/v2/solution/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/solution/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>',
'data' => [
'updatedAt' => '<string>',
'archivedAt' => '<string>',
'deletedAt' => '<string>',
'name' => '<string>',
'internalName' => '<string>',
'description' => '<string>',
'primaryUrl' => '<string>',
'qualifyingQuestions' => [
[
'question' => '<string>',
'rationale' => '<string>',
'fitType' => 'GOOD',
'weight' => 'MEDIUM',
'archivedAt' => '<string>'
]
],
'data' => [
'internalName' => '<string>',
'summary' => '<string>',
'distinctCapabilities' => [

],
'keyComponents' => [

],
'customerBenefits' => [

],
'challengesAddressed' => [

],
'statusQuo' => [

],
'differentiatedValue' => [

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

payload := strings.NewReader("{\n \"oId\": \"<string>\",\n \"data\": {\n \"updatedAt\": \"<string>\",\n \"archivedAt\": \"<string>\",\n \"deletedAt\": \"<string>\",\n \"name\": \"<string>\",\n \"internalName\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryUrl\": \"<string>\",\n \"qualifyingQuestions\": [\n {\n \"question\": \"<string>\",\n \"rationale\": \"<string>\",\n \"fitType\": \"GOOD\",\n \"weight\": \"MEDIUM\",\n \"archivedAt\": \"<string>\"\n }\n ],\n \"data\": {\n \"internalName\": \"<string>\",\n \"summary\": \"<string>\",\n \"distinctCapabilities\": [],\n \"keyComponents\": [],\n \"customerBenefits\": [],\n \"challengesAddressed\": [],\n \"statusQuo\": [],\n \"differentiatedValue\": [],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\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/solution/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"<string>\",\n \"data\": {\n \"updatedAt\": \"<string>\",\n \"archivedAt\": \"<string>\",\n \"deletedAt\": \"<string>\",\n \"name\": \"<string>\",\n \"internalName\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryUrl\": \"<string>\",\n \"qualifyingQuestions\": [\n {\n \"question\": \"<string>\",\n \"rationale\": \"<string>\",\n \"fitType\": \"GOOD\",\n \"weight\": \"MEDIUM\",\n \"archivedAt\": \"<string>\"\n }\n ],\n \"data\": {\n \"internalName\": \"<string>\",\n \"summary\": \"<string>\",\n \"distinctCapabilities\": [],\n \"keyComponents\": [],\n \"customerBenefits\": [],\n \"challengesAddressed\": [],\n \"statusQuo\": [],\n \"differentiatedValue\": [],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ]\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/solution/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 \"data\": {\n \"updatedAt\": \"<string>\",\n \"archivedAt\": \"<string>\",\n \"deletedAt\": \"<string>\",\n \"name\": \"<string>\",\n \"internalName\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryUrl\": \"<string>\",\n \"qualifyingQuestions\": [\n {\n \"question\": \"<string>\",\n \"rationale\": \"<string>\",\n \"fitType\": \"GOOD\",\n \"weight\": \"MEDIUM\",\n \"archivedAt\": \"<string>\"\n }\n ],\n \"data\": {\n \"internalName\": \"<string>\",\n \"summary\": \"<string>\",\n \"distinctCapabilities\": [],\n \"keyComponents\": [],\n \"customerBenefits\": [],\n \"challengesAddressed\": [],\n \"statusQuo\": [],\n \"differentiatedValue\": [],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\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": "sv_1234",
    "createdAt": "<string>",
    "data": {
      "internalName": "<string>",
      "summary": "<string>",
      "distinctCapabilities": [],
      "keyComponents": [],
      "customerBenefits": [],
      "challengesAddressed": [],
      "statusQuo": [],
      "differentiatedValue": [],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "workspace": {
      "oId": "<string>"
    },
    "locked": true,
    "updatedAt": "<string>",
    "archivedAt": "<string>",
    "deletedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "primaryUrl": "<string>",
    "active": true,
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "<string>"
      }
    ],
    "linkedProducts": [],
    "linkedUseCases": [],
    "linkedPersonas": [],
    "linkedSegments": [],
    "lockedBy": {
      "oId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "picture": "<string>"
    }
  }
}

Authorizations

api_key
string
header
required

Body

application/json
oId
string
required

Solution OId

data
object
required

Response

200 - application/json

Solution updated

_metadata
object
required
data
object
required