Skip to main content
POST
Split a name off a competitor

Authorizations

Authorization
string
header
required

A Searchable API key, created under Manage Account → Integrations → API Keys. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Headers

Idempotency-Key
string

Optional client-generated key (e.g. a UUID). Retrying with the same key within 24h replays the original stored response (X-Idempotent-Replay: true) instead of repeating the side effect. See Idempotency.

Path Parameters

projectId
string<uuid>
required

The project id.

competitorId
string<uuid>
required

The competitor's id.

Body

application/json
variation
string
required

One of the competitor's name variations, which becomes the new competitor's name.

Required string length: 1 - 200

Response

Split queued.

success
boolean
required
status
enum<string>
required

The change is queued; it runs in the background.

Available options:
queued
source
object
required
newCompetitorName
string
required

The new competitor's name: the variation as stored.