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",
  "businessModel": [
    "SaaS subscription",
    "Tiered pricing",
    "Enterprise focus"
  ],
  "comparativeStrengths": [
    "Market leader",
    "Extensive integration ecosystem",
    "Strong brand recognition"
  ],
  "comparativeWeaknesses": [
    "Complex setup",
    "High cost",
    "Steep learning curve"
  ],
  "keyDifferentiators": [
    "Salesforce ecosystem",
    "AI-powered insights",
    "Mobile-first approach"
  ],
  "reasonsWeWin": [
    "Lower cost",
    "Easier implementation",
    "Better customer support"
  ],
  "customersWeWon": [
    "Company A",
    "Company B"
  ],
  "customersWeSwitched": [
    "Company C",
    "Company D"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}'
{
  "_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": {
      "businessModel": [
        "<string>"
      ],
      "comparativeStrengths": [
        "<string>"
      ],
      "comparativeWeaknesses": [
        "<string>"
      ],
      "keyDifferentiators": [
        "<string>"
      ],
      "reasonsWeWin": [
        "<string>"
      ],
      "customersWeWon": [
        "<string>"
      ],
      "customersWeSwitched": [
        "<string>"
      ],
      "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

Competitor update input

oId
string
required

The ID of the competitor to update

Minimum 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"

businessModel
string[]

The business model characteristics of the competitor

Example:
[
"SaaS subscription",
"Tiered pricing",
"Enterprise focus"
]
comparativeStrengths
string[]

The comparative strengths of the competitor

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

The comparative weaknesses of the competitor

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

The key differentiators of the competitor

Example:
[
"Salesforce ecosystem",
"AI-powered insights",
"Mobile-first approach"
]
reasonsWeWin
string[]

Reasons why we win against this competitor

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

Customers we have won from this competitor

Example:
["Company A", "Company B"]
customersWeSwitched
string[]

Customers we have switched from this competitor

Example:
["Company C", "Company D"]
customFields
object[]

Custom fields for additional competitor information

Response

Competitor updated successfully

_metadata
object
required
data
object
required
I