Skip to main content
POST
Create Reference

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 | null

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