Skip to main content
POST
Update Competitor

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"

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. Pass null to clear.

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 — features, capabilities, integrations, certifications, IP, performance benchmarks, ecosystem advantages.

Example:
competitorStrengths
string[]

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

Example:
competitorWeaknesses
string[]

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

Example:
reasonsWeWin
string[]

Reasons why we win against this competitor

Example:
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:
customFields
object[]

Custom fields for additional competitor information

additionalProperties
object

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

Example:

Response

Competitor updated successfully

_metadata
object
required
data
object
required