Segments

Detach a brand from a segment

Removes the brand from the segment. The endpoint is idempotent. Both the brand and the segment must belong to the active project. Detaching a competitor from its only segment stops tracking it: the brand derives back to discovered and returns to the discover pool with its mention history intact. The own brand is implicit in every segment, so detaching it returns 422.

DELETE /api/v1/brands/{brand}/segments/{segment}

Path parameters

Name Type Required Description
brand integer Required

The numeric ID of the brand.
segment integer Required

The numeric ID of the segment.

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, derived from its context rather than stored: the brand the project's brand_id points at is own, a brand with ignored_at set is ignored, a brand attached to any segment is a competitor, and a brand with none of those is discovered. This field is read-only.
color string

A hex color used to color the brand consistently across charts. It is derived from the brand's favicon, or assigned automatically when no color can be derived. This field is read-only and is always present.
ignored_at datetime

When the brand was ignored, or null while it is not. Set and cleared through the ignored field on the update endpoint.
created_at datetime

When the brand was created.
updated_at datetime

When the brand was last updated.