Attach a brand to a segment

Attaches the given brand to the segment. The endpoint is idempotent. Both the brand and the segment must belong to the active project, and the brand must be classified as own or competitor.

POST /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. One of `own`, `competitor`, `discovered`, or `ignored`.
created_at	datetime	When the brand was created.
updated_at	datetime	When the brand was last updated.

import os import requests response = requests.post( "https://pineprompt.com/api/v1/brands/555/segments/7", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", }, ) response.raise_for_status() payload = response.json()

use GuzzleHttp\Client; $response = (new Client())->post('https://pineprompt.com/api/v1/brands/555/segments/7', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('PINEPROMPT_TOKEN'), 'Pineprompt-Project-Id' => '1', ], ]); // Guzzle throws on 4xx/5xx by default, so no manual check needed. $payload = json_decode((string) $response->getBody(), true);

{ "id": 555, "project_id": 42, "display_name": "Acme Inc.", "aliases": [ "Acme", "Acme Co" ], "domains": [ "acme.com", "acme.co" ], "kind": "competitor", "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" }