Skip to main content
POST
/
api
/
v2
/
proof-point
/
update
Update Proof Point
curl --request POST \
  --url https://app.octavehq.com/api/v2/proof-point/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data @- <<EOF
{
  "oId": "pp_1234",
  "name": "50% Sales Improvement Case Study",
  "internalName": "CompanyX_Sales_Improvement_2024",
  "description": "Customer achieved 50% improvement in sales conversion rates within 6 months",
  "type": "stat",
  "howWeTalkAboutThis": [
    "Our solution helped Company X achieve a 50% improvement in sales conversion rates",
    "Within 6 months, Company X saw significant improvement in their sales process efficiency"
  ],
  "whyThisMatters": [
    "Demonstrates quantifiable ROI in a short timeframe",
    "Shows real-world impact on sales performance",
    "Validates our solution's effectiveness in the enterprise market"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}
EOF
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "shared": true,
    "deletedAt": "<string>",
    "archivedAt": "<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>"
    }
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

Proof point update input

​
oId
string
required

The ID of the proof point to update

Minimum string length: 1
Example:

"pp_1234"

​
name
string

The name of the proof point

Example:

"50% Sales Improvement Case Study"

​
internalName
string

The internal name of the proof point

Example:

"CompanyX_Sales_Improvement_2024"

​
description
string

A description of the proof point

Example:

"Customer achieved 50% improvement in sales conversion rates within 6 months"

​
type
enum<string>

The type of proof point

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

"stat"

​
howWeTalkAboutThis
string[]

How we talk about this proof point

Example:
[
  "Our solution helped Company X achieve a 50% improvement in sales conversion rates",
  "Within 6 months, Company X saw significant improvement in their sales process efficiency"
]
​
whyThisMatters
string[]

Why this proof point matters

Example:
[
  "Demonstrates quantifiable ROI in a short timeframe",
  "Shows real-world impact on sales performance",
  "Validates our solution's effectiveness in the enterprise market"
]
​
customFields
object[]

Custom fields for additional proof point information

Response

Proof point updated successfully

​
_metadata
object
required
​
data
object
required