Update competitor
Update only supplied fields. Omitted values are preserved.
/projects/{projectId}/competitors/{id}competitors: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.
Path parameters
projectIdstringRequiredProject identifier from List projects.
idstringRequiredIdentifier from the corresponding resource list.
Request body
application/json. Unknown fields are rejected. Changes apply only to supplied fields; provide at least one field.
namestringOptionalDisplay name, up to 100 characters; defaults to domain.
domainstringOptionalPublic website domain, up to 500 characters.
domainAliasesstring[]OptionalUp to 20 additional domains.
brandAliasesstring[]OptionalUp to 20 distinct brand names, each 2–100 characters.
archivedbooleanOptionalArchive or restore; change archive status separately from identity fields.
Response fields
dataobjectRequiredUpdate only supplied fields. Omitted values are preserved.
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.