Skip to main content
POST
/
api
/
v2
/
reference
/
create
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 '
{
  "name": "Large filesharing service",
  "internalName": "Dropbox",
  "description": "Leading cloud storage and file sharing company",
  "data": {
    "howTheyMakeMoney": "<string>",
    "howTheyUseProduct": "<string>",
    "howTheyBenefitFromProduct": "<string>",
    "howWeImpactedTheirBusiness": [
      "<string>"
    ],
    "keyStats": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  }
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "r_1234",
    "createdAt": "2021-01-01",
    "data": {
      "howTheyMakeMoney": "<string>",
      "howTheyUseProduct": "<string>",
      "howTheyBenefitFromProduct": "<string>",
      "emailSnippets": [
        "<string>"
      ],
      "howWeImpactedTheirBusiness": [
        "<string>"
      ],
      "keyStats": [
        "<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 creation data

​
name
string
required

The external facing name of the reference

Minimum string length: 1
Example:

"Large filesharing service"

​
internalName
string

The internal name of the reference

Example:

"Dropbox"

​
description
string

A description of the reference

Example:

"Leading cloud storage and file sharing company"

​
data
object

Additional reference data

​
primaryOfferingOId
string

Primary Offering to use as context when creating reference. If not provided, the primary company attached to the Workspace will be used.

Example:

"o_123456"

​
linkingStrategy
object

Strategy for linking this reference to offerings (products/services)

Response

Reference created successfully

​
_metadata
object
required
​
data
object
required