Skip to main content
POST
Create Competitor

Authorizations

api_key
string
header
required

Body

application/json

Competitor creation input

name
string
required

The external name of the competitor

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

url
string | null

The competitor's canonical web URL — the company homepage, or the product page when the competitor is a product of a larger company. A bare domain is also accepted. Used to resolve the competitor's logo.

Example:

"https://salesforce.com"

howTheyPosition
string[]

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

Example:
ourKeyDifferentiators
string[]

Concrete, observable, tactical points of differentiation we lead with against this competitor.

Example:
competitorStrengths
string[]

Where this competitor genuinely excels.

Example:
competitorWeaknesses
string[]

Where this competitor falls short.

Example:
reasonsWeWin
string[]

Key reasons why customers choose your solution over this competitor

Example:
reasonsWeLose
string[]

The deal-level dynamics for why customers might choose them when both are evaluated.

Example:
customFields
object[]

Custom fields for additional competitor information

additionalProperties
object

Workspace-defined additional property values for this competitor, keyed by property key.

Example:
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 competitor to offerings (products/services)

Response

Competitor created successfully

_metadata
object
required
data
object
required