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>"
      ]
    }
  ]
}
'
{
  "_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>"
    }
  }
}

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