Skip to content
ansvra.Documentation
Competitors
Competitors

Create competitor

Create one competitor. Account allowances and project availability apply.

POST/projects/{projectId}/competitors
Required permission competitors:write

The key must include this project and its owner must still have access.

Authentication and permissions · Errors and limits

Authorization

Authorizationstring · headerRequired

Bearer access key. Never put a key in the URL.

Idempotency-Keystring · headerRequired

Required for creation: 1–128 letters, numbers, dots, underscores, colons or hyphens. Reuse for retries of the same request within 24 hours.

Path parameters

projectIdstringRequired

Project identifier from List projects.

Request body

application/json. Unknown fields are rejected.

namestringOptional

Display name, up to 100 characters; defaults to domain.

domainstringRequired

Public website domain, up to 500 characters.

domainAliasesstring[]Optional

Up to 20 additional domains.

Default: []

brandAliasesstring[]Optional

Up to 20 distinct brand names, each 2–100 characters.

Default: []

Response fields

dataobjectRequired

Create one competitor. Account allowances and project availability apply.

Child fields
idstringRequired

Unique identifier for this record.

projectIdstringRequired

Project that owns this record.

namestringRequired

Saved name.

domainstringRequired

Saved domain.

domainAliasesJSONRequired

Saved domain aliases.

brandAliasesJSONRequired

Saved brand aliases.

archivedbooleanRequired

Saved archived.

createdAtISO 8601 timestampRequired

When this record was saved, in UTC.

updatedAtISO 8601 timestampRequired

When this record last changed, in UTC.

metaobjectRequired

Request metadata. Present on JSON success responses.

Child fields
requestIdstringRequired

Request identifier to include when contacting support.

resultScope"saved"Required

Saved customer information; excludes Overview preview results.

Ansvra

A clearer next step.

MEET YOUR AI GUIDE

A little clarity.
A clearer next move.

Ask about Ansvra, AI visibility, or your next step with content.

Opening chat…