Skip to main content
POST
/
api
/
v2
/
competitor
/
create
Create Competitor
curl --request POST \
  --url https://app.octavehq.com/api/v2/competitor/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "name": "Salesforce",
  "internalName": "SFDC - The CRM Giant",
  "description": "Leading CRM platform with strong enterprise presence",
  "businessModel": [
    "SaaS subscription",
    "Professional services",
    "Marketplace"
  ],
  "comparativeStrengths": [
    "Market leader",
    "Strong brand recognition",
    "Enterprise customer base"
  ],
  "comparativeWeaknesses": [
    "Complex implementation",
    "High cost",
    "Poor customer support"
  ],
  "keyDifferentiators": [
    "AI-powered analytics",
    "Industry-specific features",
    "Global presence"
  ],
  "reasonsWeWin": [
    "Better pricing",
    "Easier implementation",
    "Superior customer support"
  ],
  "customersWeWon": [
    "Acme Corp",
    "TechStart Inc",
    "Global Manufacturing Ltd"
  ],
  "customersWeSwitched": [
    "Enterprise Solutions Co",
    "Innovation Labs"
  ],
  "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": {
      "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 creation input

name
string
required

The external name of the competitor

Minimum length: 1
Example:

"Salesforce"

internalName
string

The internal name of the competitor

Example:

"SFDC - The CRM Giant"

description
string

A description of the competitor

Example:

"Leading CRM platform with strong enterprise presence"

businessModel
string[]

The competitor's business model components

Example:
[
"SaaS subscription",
"Professional services",
"Marketplace"
]
comparativeStrengths
string[]

Key strengths of the competitor relative to your offering

Example:
[
"Market leader",
"Strong brand recognition",
"Enterprise customer base"
]
comparativeWeaknesses
string[]

Key weaknesses of the competitor relative to your offering

Example:
[
"Complex implementation",
"High cost",
"Poor customer support"
]
keyDifferentiators
string[]

What makes this competitor different from others

Example:
[
"AI-powered analytics",
"Industry-specific features",
"Global presence"
]
reasonsWeWin
string[]

Key reasons why customers choose your solution over this competitor

Example:
[
"Better pricing",
"Easier implementation",
"Superior customer support"
]
customersWeWon
string[]

Notable customers won from this competitor

Example:
[
"Acme Corp",
"TechStart Inc",
"Global Manufacturing Ltd"
]
customersWeSwitched
string[]

Customers who switched from this competitor to your solution

Example:
[
"Enterprise Solutions Co",
"Innovation Labs"
]
customFields
object[]

Custom fields for additional competitor information

primaryOfferingOId
string

Primary Offering to use as context when creating competitors. 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 competitor to products/offerings

  • Option 1
  • Option 2

Response

Competitor created successfully

_metadata
object
required
data
object
required
I