Skip to main content
POST
/
api
/
v2
/
proof-point
/
create
Create Proof Point
curl --request POST \
  --url https://app.octavehq.com/api/v2/proof-point/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "name": "99% Customer Satisfaction",
  "internalName": "Customer Satisfaction Stat - Q4 2024",
  "description": "Our customer satisfaction rate consistently exceeds 99%",
  "type": "stat",
  "howWeTalkAboutThis": [
    "99% customer satisfaction rate",
    "Nearly perfect customer satisfaction",
    "Best-in-class customer experience"
  ],
  "whyThisMatters": [
    "Shows customer trust",
    "Demonstrates product quality",
    "Proves our commitment to excellence"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ],
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  }
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "data": {
    "oId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "active": true,
    "data": {
      "howWeTalkAboutThis": [
        "<string>"
      ],
      "whyThisMatters": [
        "<string>"
      ],
      "type": "stat",
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "<string>"
    },
    "shared": true
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Proof point creation input

name
string
required

The external name of the proof point

Minimum length: 1
Example:

"99% Customer Satisfaction"

internalName
string

The internal name of the proof point

Example:

"Customer Satisfaction Stat - Q4 2024"

description
string

A description of the proof point

Example:

"Our customer satisfaction rate consistently exceeds 99%"

type
enum<string>

The type of proof point

Available options:
stat,
fact,
quote,
award,
recognition,
other
Example:

"stat"

howWeTalkAboutThis
string[]

Different ways to present or talk about this proof point

Example:
[
"99% customer satisfaction rate",
"Nearly perfect customer satisfaction",
"Best-in-class customer experience"
]
whyThisMatters
string[]

Explanations of why this proof point is significant

Example:
[
"Shows customer trust",
"Demonstrates product quality",
"Proves our commitment to excellence"
]
customFields
object[]

Custom fields for additional proof point information

primaryOfferingOId
string

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

Example:

"o_123456"

linkingStrategy
object

Strategy for linking this persona to products/offerings Strategy for linking this proof point to products/offerings

  • Option 1
  • Option 2

Response

Proof point created successfully

_metadata
object
required
data
object
required
I