Skip to main content
POST
/
api
/
v2
/
competitor
/
update
Update Competitor
curl --request POST \
  --url https://app.octavehq.com/api/v2/competitor/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "oId": "cp_1234",
  "name": "Salesforce CRM",
  "internalName": "Salesforce (Main CRM Competitor)",
  "description": "Leading CRM platform with extensive enterprise features",
  "howTheyPosition": [
    "Positions as the all-in-one CRM for enterprises.",
    "Frames AI as the core differentiator across every product line."
  ],
  "ourKeyDifferentiators": [
    "Native event-driven sync with Postgres CDC.",
    "Built-in SOC2 audit reporting at no extra cost."
  ],
  "competitorStrengths": [
    "Market leader",
    "Extensive integration ecosystem",
    "Strong brand recognition"
  ],
  "competitorWeaknesses": [
    "Complex setup",
    "High cost",
    "Steep learning curve"
  ],
  "reasonsWeWin": [
    "Lower cost",
    "Easier implementation",
    "Better customer support"
  ],
  "reasonsWeLose": [
    "Existing Salesforce-heavy stack with deep org-wide adoption.",
    "Procurement preference for the incumbent vendor."
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}
'
{
  "_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>",
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "active": true,
    "data": {
      "howTheyPosition": [
        "<string>"
      ],
      "ourKeyDifferentiators": [
        "<string>"
      ],
      "competitorStrengths": [
        "<string>"
      ],
      "competitorWeaknesses": [
        "<string>"
      ],
      "reasonsWeWin": [
        "<string>"
      ],
      "reasonsWeLose": [
        "<string>"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "<string>"
    }
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

Competitor update input

​
oId
string
required

The ID of the competitor to update

Minimum string length: 1
Example:

"cp_1234"

​
name
string

The name of the competitor

Example:

"Salesforce CRM"

​
internalName
string

The internal name of the competitor

Example:

"Salesforce (Main CRM Competitor)"

​
description
string

A description of the competitor

Example:

"Leading CRM platform with extensive enterprise features"

​
howTheyPosition
string[]

How the competitor positions themselves: their narrative, messaging, and market story — the pitch they take to market.

Example:
[
  "Positions as the all-in-one CRM for enterprises.",
  "Frames AI as the core differentiator across every product line."
]
​
ourKeyDifferentiators
string[]

Concrete, observable, tactical points of differentiation we lead with against this competitor — features, capabilities, integrations, certifications, IP, performance benchmarks, ecosystem advantages.

Example:
[
  "Native event-driven sync with Postgres CDC.",
  "Built-in SOC2 audit reporting at no extra cost."
]
​
competitorStrengths
string[]

Where this competitor genuinely excels — capabilities, features, market position, brand recognition, ecosystem advantages.

Example:
[
  "Market leader",
  "Extensive integration ecosystem",
  "Strong brand recognition"
]
​
competitorWeaknesses
string[]

Where this competitor falls short — gaps in their offering, capability holes, pricing rigidity, ecosystem limitations.

Example:
[
  "Complex setup",
  "High cost",
  "Steep learning curve"
]
​
reasonsWeWin
string[]

Reasons why we win against this competitor

Example:
[
  "Lower cost",
  "Easier implementation",
  "Better customer support"
]
​
reasonsWeLose
string[]

The deal-level dynamics for why customers might choose them when both are evaluated — the kinds of prospects, requirements, scenarios, or buyer types that favor them.

Example:
[
  "Existing Salesforce-heavy stack with deep org-wide adoption.",
  "Procurement preference for the incumbent vendor."
]
​
customFields
object[]

Custom fields for additional competitor information

Response

Competitor updated successfully

​
_metadata
object
required
​
data
object
required