Create competitor
Create one competitor. Account allowances and project availability apply.
/projects/{projectId}/competitorscompetitors:writeThe key must include this project and its owner must still have access.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Idempotency-Keystring · headerRequiredRequired for creation: 1–128 letters, numbers, dots, underscores, colons or hyphens. Reuse for retries of the same request within 24 hours.
Path parameters
projectIdstringRequiredProject identifier from List projects.
Request body
application/json. Unknown fields are rejected.
namestringOptionalDisplay name, up to 100 characters; defaults to domain.
domainstringRequiredPublic website domain, up to 500 characters.
domainAliasesstring[]OptionalUp to 20 additional domains.
Default:
[]brandAliasesstring[]OptionalUp to 20 distinct brand names, each 2–100 characters.
Default:
[]
Response fields
dataobjectRequiredCreate one competitor. Account allowances and project availability apply.
Child fields
idstringRequiredUnique identifier for this record.
projectIdstringRequiredProject that owns this record.
namestringRequiredSaved name.
domainstringRequiredSaved domain.
domainAliasesJSONRequiredSaved domain aliases.
brandAliasesJSONRequiredSaved brand aliases.
archivedbooleanRequiredSaved archived.
createdAtISO 8601 timestampRequiredWhen this record was saved, in UTC.
updatedAtISO 8601 timestampRequiredWhen this record last changed, in UTC.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.