Skip to main content
POST
/
api
/
v2
/
reference
/
update
Update Reference
curl --request POST \
  --url https://app.octavehq.com/api/v2/reference/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data @- <<EOF
{
  "oId": "ref_1234",
  "name": "Acme Corporation",
  "internalName": "Acme Corp (Internal)",
  "description": "Leading technology company that achieved 50% growth using our solution",
  "businessModel": "SaaS platform with subscription revenue model",
  "theirChallenge": "Manual onboarding bottlenecks were forcing them to cap new-customer growth and tying up CS bandwidth.",
  "howTheyUseUs": "Uses our API to integrate with their customer onboarding flow",
  "whyTheyChoseUs": "Evaluated three vendors but chose us for the API depth and real-time event streaming the others lacked.",
  "impactTheySaw": [
    "Reduced customer onboarding time by 60%",
    "Improved customer satisfaction by 25%",
    "Cut operational costs by 30%"
  ],
  "stakeholdersInvolved": [
    "VP of Customer Success — owned the onboarding KPI and championed the rollout.",
    "Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team."
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}
EOF
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "r_1234",
    "createdAt": "2021-01-01",
    "data": {
      "businessModel": "<string>",
      "theirChallenge": "<string>",
      "howTheyUseUs": "<string>",
      "whyTheyChoseUs": "<string>",
      "impactTheySaw": [
        "<string>"
      ],
      "stakeholdersInvolved": [
        "<string>"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "u_1234",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "w_1234"
    },
    "name": "Large filesharing service",
    "internalName": "Dropbox",
    "updatedAt": "2021-01-01",
    "deletedAt": "2021-01-01",
    "archivedAt": "2021-01-01",
    "description": "Description of the reference",
    "active": true,
    "unrecognized": false
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

Reference update input

​
oId
string
required

The ID of the reference to update

Minimum string length: 1
Example:

"ref_1234"

​
name
string

The name of the reference

Example:

"Acme Corporation"

​
internalName
string

The internal name of the reference

Example:

"Acme Corp (Internal)"

​
description
string

A description of the reference

Example:

"Leading technology company that achieved 50% growth using our solution"

​
businessModel
string

How the customer operates commercially: revenue model, pricing structure, sales motion, and commercial dynamics.

Example:

"SaaS platform with subscription revenue model"

​
theirChallenge
string

What was broken before they came to us — the pain, what they had tried that didn't work, and what triggered them to look for a better way.

Example:

"Manual onboarding bottlenecks were forcing them to cap new-customer growth and tying up CS bandwidth."

​
howTheyUseUs
string

What they use us for in practice — which offerings they've adopted, how they've embedded them into their workflows, and the role we now play in their day-to-day operations.

Example:

"Uses our API to integrate with their customer onboarding flow"

​
whyTheyChoseUs
string

The decision rationale: alternatives they considered, what made our offering stand out, and the specific factors that tipped them toward us.

Example:

"Evaluated three vendors but chose us for the API depth and real-time event streaming the others lacked."

​
impactTheySaw
string[]

The meaningful change attributable to working with us — qualitative shifts in their business and quantifiable metrics (when available). The 'before vs. after' story told with both narrative and numbers.

Example:
[
  "Reduced customer onboarding time by 60%",
  "Improved customer satisfaction by 25%",
  "Cut operational costs by 30%"
]
​
stakeholdersInvolved
string[]

Roles, titles, and personas at the customer who drove and championed the work, and why they cared about this problem.

Example:
[
  "VP of Customer Success — owned the onboarding KPI and championed the rollout.",
  "Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team."
]
​
customFields
object[]

Custom fields for additional reference information

Response

Reference updated successfully

​
_metadata
object
required
​
data
object
required