Brands

Update a brand

Reclassifies a brand. The only writable field on a brand is its kind, which may be own, competitor, or ignored. A project may have at most one own brand, so assigning own while another own brand already exists returns a 422. When you reclassify a brand from own or competitor to ignored, Pineprompt will automatically detach the brand from every segment it belonged to.

PUT /api/v1/brands/{brand}

The discovered classification is reserved for brands that Pineprompt has surfaced but you have not yet reviewed, so you may not set this value yourself through the API.

A project may classify at most one of its brands as own. If you classify a brand as own while another own brand already exists in the project, the request fails validation with a 422. Of course, re-sending own for the brand that is already your own brand succeeds without error, so a client that replays the full resource on every update is safe. To move the designation to a different brand, you should first reclassify the current own brand to competitor or ignored.

Only own and competitor brands may belong to a segment. When you reclassify a tracked brand to any other kind (in practice, ignored), Pineprompt will automatically detach the brand from every segment it belonged to, which keeps the data model consistent.

Path parameters

Name Type Required Description
brand integer Required

The numeric ID of the brand.

Body parameters

Name Type Required Description
kind string Required

The classification you would like to assign to the brand. One of own, competitor, or ignored. The discovered kind may not be set through the API. A project may have only one own brand, so assigning own while another own brand already exists returns a 422.

Response

The brand object

Field Type Description
id integer

The unique ID of the brand.
project_id integer

The ID of the project the brand belongs to.
display_name string

The canonical display name of the brand.
aliases string[]

Alternative names that the brand is referred to by.
domains string[]

The web domains associated with the brand.
kind string

The brand's classification. One of own, competitor, discovered, or ignored.
created_at datetime

When the brand was created.
updated_at datetime

When the brand was last updated.