PATCH
Update Competitor

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Headers

Idempotency-Key
string | null

Any unique string, such as a UUID. Send the same key again to get the first answer and not a second write. The API keeps an answer for 24 hours.

Path Parameters

competitor_id
integer
required

A competitor of the brand.

brand_id
integer
required

Body

application/json

Only the fields that the request sends change.

is_actual
boolean | null

true: track the competitor (a suggestion becomes a competitor). false: the competitor goes back to the suggestions.

name
string | null
Required string length: 1 - 255
website
string | null
Maximum string length: 2048

Response

Successful Response

id
integer
required
is_actual
boolean
required
name
string
required
website
string | null