curl --request POST \
--url https://app.octavehq.com/api/v2/reference/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"oId": "ref_1234",
"name": "Acme Corporation",
"internalName": "Acme Corp (Internal)",
"description": "Leading technology company that achieved 50% growth using our solution",
"howTheyMakeMoney": "SaaS platform with subscription revenue model",
"howTheyUseProduct": "Uses our API to integrate with their customer onboarding flow",
"howTheyBenefitFromProduct": "Reduced customer onboarding time by 60% and improved satisfaction",
"emailSnippets": [
"Acme saw 50% growth in 6 months",
"Award-winning implementation"
],
"howWeImpactedTheirBusiness": [
"Increased conversion rate",
"Reduced operational costs",
"Improved customer satisfaction"
],
"keyStats": [
"50% growth in 6 months",
"10,000+ users",
"$2M ARR"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"data": {
"oId": "r_1234",
"name": "Large filesharing service",
"internalName": "Dropbox",
"createdAt": "2021-01-01",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"description": "Description of the reference",
"active": true,
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234"
},
"workspace": {
"oId": "w_1234"
},
"unrecognized": false
}
}
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 '{
"oId": "ref_1234",
"name": "Acme Corporation",
"internalName": "Acme Corp (Internal)",
"description": "Leading technology company that achieved 50% growth using our solution",
"howTheyMakeMoney": "SaaS platform with subscription revenue model",
"howTheyUseProduct": "Uses our API to integrate with their customer onboarding flow",
"howTheyBenefitFromProduct": "Reduced customer onboarding time by 60% and improved satisfaction",
"emailSnippets": [
"Acme saw 50% growth in 6 months",
"Award-winning implementation"
],
"howWeImpactedTheirBusiness": [
"Increased conversion rate",
"Reduced operational costs",
"Improved customer satisfaction"
],
"keyStats": [
"50% growth in 6 months",
"10,000+ users",
"$2M ARR"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"data": {
"oId": "r_1234",
"name": "Large filesharing service",
"internalName": "Dropbox",
"createdAt": "2021-01-01",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"description": "Description of the reference",
"active": true,
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234"
},
"workspace": {
"oId": "w_1234"
},
"unrecognized": false
}
}
Reference update input
The body is of type object
.
Reference updated successfully
The response is of type object
.