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",
"Mid-market sales motion with annual contracts"
],
"theirChallenge": [
"Manual onboarding bottlenecks were capping new-customer growth.",
"Internal scripts kept breaking under load and tying up CS bandwidth."
],
"howTheyUseUs": [
"Uses our API to integrate with their customer onboarding flow.",
"Runs nightly reconciliation through our reporting pipeline."
],
"whyTheyChoseUs": [
"Chose us for the API depth and real-time event streaming the others lacked.",
"Existing team expertise made our SDK the lowest-friction path to production."
],
"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>"
]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
EOFimport requests
url = "https://app.octavehq.com/api/v2/reference/update"
payload = {
"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", "Mid-market sales motion with annual contracts"],
"theirChallenge": ["Manual onboarding bottlenecks were capping new-customer growth.", "Internal scripts kept breaking under load and tying up CS bandwidth."],
"howTheyUseUs": ["Uses our API to integrate with their customer onboarding flow.", "Runs nightly reconciliation through our reporting pipeline."],
"whyTheyChoseUs": ["Chose us for the API depth and real-time event streaming the others lacked.", "Existing team expertise made our SDK the lowest-friction path to production."],
"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>"]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
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: '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',
'Mid-market sales motion with annual contracts'
],
theirChallenge: [
'Manual onboarding bottlenecks were capping new-customer growth.',
'Internal scripts kept breaking under load and tying up CS bandwidth.'
],
howTheyUseUs: [
'Uses our API to integrate with their customer onboarding flow.',
'Runs nightly reconciliation through our reporting pipeline.'
],
whyTheyChoseUs: [
'Chose us for the API depth and real-time event streaming the others lacked.',
'Existing team expertise made our SDK the lowest-friction path to production.'
],
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>']}],
additionalProperties: {tier: 'Enterprise', region: 'APAC'}
})
};
fetch('https://app.octavehq.com/api/v2/reference/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/reference/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' => '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',
'Mid-market sales motion with annual contracts'
],
'theirChallenge' => [
'Manual onboarding bottlenecks were capping new-customer growth.',
'Internal scripts kept breaking under load and tying up CS bandwidth.'
],
'howTheyUseUs' => [
'Uses our API to integrate with their customer onboarding flow.',
'Runs nightly reconciliation through our reporting pipeline.'
],
'whyTheyChoseUs' => [
'Chose us for the API depth and real-time event streaming the others lacked.',
'Existing team expertise made our SDK the lowest-friction path to production.'
],
'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>'
]
]
],
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
]
]),
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/reference/update"
payload := strings.NewReader("{\n \"oId\": \"ref_1234\",\n \"name\": \"Acme Corporation\",\n \"internalName\": \"Acme Corp (Internal)\",\n \"description\": \"Leading technology company that achieved 50% growth using our solution\",\n \"businessModel\": [\n \"SaaS platform with subscription revenue model\",\n \"Mid-market sales motion with annual contracts\"\n ],\n \"theirChallenge\": [\n \"Manual onboarding bottlenecks were capping new-customer growth.\",\n \"Internal scripts kept breaking under load and tying up CS bandwidth.\"\n ],\n \"howTheyUseUs\": [\n \"Uses our API to integrate with their customer onboarding flow.\",\n \"Runs nightly reconciliation through our reporting pipeline.\"\n ],\n \"whyTheyChoseUs\": [\n \"Chose us for the API depth and real-time event streaming the others lacked.\",\n \"Existing team expertise made our SDK the lowest-friction path to production.\"\n ],\n \"impactTheySaw\": [\n \"Reduced customer onboarding time by 60%\",\n \"Improved customer satisfaction by 25%\",\n \"Cut operational costs by 30%\"\n ],\n \"stakeholdersInvolved\": [\n \"VP of Customer Success — owned the onboarding KPI and championed the rollout.\",\n \"Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team.\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\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/reference/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"ref_1234\",\n \"name\": \"Acme Corporation\",\n \"internalName\": \"Acme Corp (Internal)\",\n \"description\": \"Leading technology company that achieved 50% growth using our solution\",\n \"businessModel\": [\n \"SaaS platform with subscription revenue model\",\n \"Mid-market sales motion with annual contracts\"\n ],\n \"theirChallenge\": [\n \"Manual onboarding bottlenecks were capping new-customer growth.\",\n \"Internal scripts kept breaking under load and tying up CS bandwidth.\"\n ],\n \"howTheyUseUs\": [\n \"Uses our API to integrate with their customer onboarding flow.\",\n \"Runs nightly reconciliation through our reporting pipeline.\"\n ],\n \"whyTheyChoseUs\": [\n \"Chose us for the API depth and real-time event streaming the others lacked.\",\n \"Existing team expertise made our SDK the lowest-friction path to production.\"\n ],\n \"impactTheySaw\": [\n \"Reduced customer onboarding time by 60%\",\n \"Improved customer satisfaction by 25%\",\n \"Cut operational costs by 30%\"\n ],\n \"stakeholdersInvolved\": [\n \"VP of Customer Success — owned the onboarding KPI and championed the rollout.\",\n \"Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team.\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/reference/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\": \"ref_1234\",\n \"name\": \"Acme Corporation\",\n \"internalName\": \"Acme Corp (Internal)\",\n \"description\": \"Leading technology company that achieved 50% growth using our solution\",\n \"businessModel\": [\n \"SaaS platform with subscription revenue model\",\n \"Mid-market sales motion with annual contracts\"\n ],\n \"theirChallenge\": [\n \"Manual onboarding bottlenecks were capping new-customer growth.\",\n \"Internal scripts kept breaking under load and tying up CS bandwidth.\"\n ],\n \"howTheyUseUs\": [\n \"Uses our API to integrate with their customer onboarding flow.\",\n \"Runs nightly reconciliation through our reporting pipeline.\"\n ],\n \"whyTheyChoseUs\": [\n \"Chose us for the API depth and real-time event streaming the others lacked.\",\n \"Existing team expertise made our SDK the lowest-friction path to production.\"\n ],\n \"impactTheySaw\": [\n \"Reduced customer onboarding time by 60%\",\n \"Improved customer satisfaction by 25%\",\n \"Cut operational costs by 30%\"\n ],\n \"stakeholdersInvolved\": [\n \"VP of Customer Success — owned the onboarding KPI and championed the rollout.\",\n \"Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team.\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\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": "r_1234",
"createdAt": "2021-01-01",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"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
}
}{
"_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>"
}Update Reference
Update an existing 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",
"Mid-market sales motion with annual contracts"
],
"theirChallenge": [
"Manual onboarding bottlenecks were capping new-customer growth.",
"Internal scripts kept breaking under load and tying up CS bandwidth."
],
"howTheyUseUs": [
"Uses our API to integrate with their customer onboarding flow.",
"Runs nightly reconciliation through our reporting pipeline."
],
"whyTheyChoseUs": [
"Chose us for the API depth and real-time event streaming the others lacked.",
"Existing team expertise made our SDK the lowest-friction path to production."
],
"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>"
]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
EOFimport requests
url = "https://app.octavehq.com/api/v2/reference/update"
payload = {
"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", "Mid-market sales motion with annual contracts"],
"theirChallenge": ["Manual onboarding bottlenecks were capping new-customer growth.", "Internal scripts kept breaking under load and tying up CS bandwidth."],
"howTheyUseUs": ["Uses our API to integrate with their customer onboarding flow.", "Runs nightly reconciliation through our reporting pipeline."],
"whyTheyChoseUs": ["Chose us for the API depth and real-time event streaming the others lacked.", "Existing team expertise made our SDK the lowest-friction path to production."],
"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>"]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
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: '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',
'Mid-market sales motion with annual contracts'
],
theirChallenge: [
'Manual onboarding bottlenecks were capping new-customer growth.',
'Internal scripts kept breaking under load and tying up CS bandwidth.'
],
howTheyUseUs: [
'Uses our API to integrate with their customer onboarding flow.',
'Runs nightly reconciliation through our reporting pipeline.'
],
whyTheyChoseUs: [
'Chose us for the API depth and real-time event streaming the others lacked.',
'Existing team expertise made our SDK the lowest-friction path to production.'
],
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>']}],
additionalProperties: {tier: 'Enterprise', region: 'APAC'}
})
};
fetch('https://app.octavehq.com/api/v2/reference/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/reference/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' => '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',
'Mid-market sales motion with annual contracts'
],
'theirChallenge' => [
'Manual onboarding bottlenecks were capping new-customer growth.',
'Internal scripts kept breaking under load and tying up CS bandwidth.'
],
'howTheyUseUs' => [
'Uses our API to integrate with their customer onboarding flow.',
'Runs nightly reconciliation through our reporting pipeline.'
],
'whyTheyChoseUs' => [
'Chose us for the API depth and real-time event streaming the others lacked.',
'Existing team expertise made our SDK the lowest-friction path to production.'
],
'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>'
]
]
],
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
]
]),
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/reference/update"
payload := strings.NewReader("{\n \"oId\": \"ref_1234\",\n \"name\": \"Acme Corporation\",\n \"internalName\": \"Acme Corp (Internal)\",\n \"description\": \"Leading technology company that achieved 50% growth using our solution\",\n \"businessModel\": [\n \"SaaS platform with subscription revenue model\",\n \"Mid-market sales motion with annual contracts\"\n ],\n \"theirChallenge\": [\n \"Manual onboarding bottlenecks were capping new-customer growth.\",\n \"Internal scripts kept breaking under load and tying up CS bandwidth.\"\n ],\n \"howTheyUseUs\": [\n \"Uses our API to integrate with their customer onboarding flow.\",\n \"Runs nightly reconciliation through our reporting pipeline.\"\n ],\n \"whyTheyChoseUs\": [\n \"Chose us for the API depth and real-time event streaming the others lacked.\",\n \"Existing team expertise made our SDK the lowest-friction path to production.\"\n ],\n \"impactTheySaw\": [\n \"Reduced customer onboarding time by 60%\",\n \"Improved customer satisfaction by 25%\",\n \"Cut operational costs by 30%\"\n ],\n \"stakeholdersInvolved\": [\n \"VP of Customer Success — owned the onboarding KPI and championed the rollout.\",\n \"Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team.\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\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/reference/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"ref_1234\",\n \"name\": \"Acme Corporation\",\n \"internalName\": \"Acme Corp (Internal)\",\n \"description\": \"Leading technology company that achieved 50% growth using our solution\",\n \"businessModel\": [\n \"SaaS platform with subscription revenue model\",\n \"Mid-market sales motion with annual contracts\"\n ],\n \"theirChallenge\": [\n \"Manual onboarding bottlenecks were capping new-customer growth.\",\n \"Internal scripts kept breaking under load and tying up CS bandwidth.\"\n ],\n \"howTheyUseUs\": [\n \"Uses our API to integrate with their customer onboarding flow.\",\n \"Runs nightly reconciliation through our reporting pipeline.\"\n ],\n \"whyTheyChoseUs\": [\n \"Chose us for the API depth and real-time event streaming the others lacked.\",\n \"Existing team expertise made our SDK the lowest-friction path to production.\"\n ],\n \"impactTheySaw\": [\n \"Reduced customer onboarding time by 60%\",\n \"Improved customer satisfaction by 25%\",\n \"Cut operational costs by 30%\"\n ],\n \"stakeholdersInvolved\": [\n \"VP of Customer Success — owned the onboarding KPI and championed the rollout.\",\n \"Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team.\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/reference/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\": \"ref_1234\",\n \"name\": \"Acme Corporation\",\n \"internalName\": \"Acme Corp (Internal)\",\n \"description\": \"Leading technology company that achieved 50% growth using our solution\",\n \"businessModel\": [\n \"SaaS platform with subscription revenue model\",\n \"Mid-market sales motion with annual contracts\"\n ],\n \"theirChallenge\": [\n \"Manual onboarding bottlenecks were capping new-customer growth.\",\n \"Internal scripts kept breaking under load and tying up CS bandwidth.\"\n ],\n \"howTheyUseUs\": [\n \"Uses our API to integrate with their customer onboarding flow.\",\n \"Runs nightly reconciliation through our reporting pipeline.\"\n ],\n \"whyTheyChoseUs\": [\n \"Chose us for the API depth and real-time event streaming the others lacked.\",\n \"Existing team expertise made our SDK the lowest-friction path to production.\"\n ],\n \"impactTheySaw\": [\n \"Reduced customer onboarding time by 60%\",\n \"Improved customer satisfaction by 25%\",\n \"Cut operational costs by 30%\"\n ],\n \"stakeholdersInvolved\": [\n \"VP of Customer Success — owned the onboarding KPI and championed the rollout.\",\n \"Head of Engineering — needed an API-first solution that wouldn't bottleneck the dev team.\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\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": "r_1234",
"createdAt": "2021-01-01",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"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
}
}{
"_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
Body
Reference update input
The ID of the reference to update
1"ref_1234"
The name of the reference
"Acme Corporation"
The internal name of the reference
"Acme Corp (Internal)"
A description of the reference
"Leading technology company that achieved 50% growth using our solution"
How the customer operates commercially: revenue model, pricing structure, sales motion, and commercial dynamics.
[
"SaaS platform with subscription revenue model",
"Mid-market sales motion with annual contracts"
]
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.
[
"Manual onboarding bottlenecks were capping new-customer growth.",
"Internal scripts kept breaking under load and tying up CS bandwidth."
]
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.
[
"Uses our API to integrate with their customer onboarding flow.",
"Runs nightly reconciliation through our reporting pipeline."
]
The decision rationale: alternatives they considered, what made our offering stand out, and the specific factors that tipped them toward us.
[
"Chose us for the API depth and real-time event streaming the others lacked.",
"Existing team expertise made our SDK the lowest-friction path to production."
]
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.
[
"Reduced customer onboarding time by 60%",
"Improved customer satisfaction by 25%",
"Cut operational costs by 30%"
]
Roles, titles, and personas at the customer who drove and championed the work, and why they cared about this problem.
[
"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."
]
Custom fields for additional reference information
Show child attributes
Show child attributes
Workspace-defined additional property values for this reference, keyed by property key.
Show child attributes
Show child attributes
{ "tier": "Enterprise", "region": "APAC" }