curl --request POST \
--url https://app.octavehq.com/api/v2/reference/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"productOId": "<string>",
"url": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"details": "<string>"
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"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
}
Create Reference
curl --request POST \
--url https://app.octavehq.com/api/v2/reference/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"productOId": "<string>",
"url": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"details": "<string>"
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"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 creation input
The body is of type object
.
Reference data
The response is of type object
.