Update a segment

Renames a segment. Since this endpoint uses PUT semantics, name is required on the request body.

PUT /api/v1/segments/{segment}

Path parameters

Name	Type	Required	Description
segment	integer	Required	The numeric ID of the segment.

Body parameters

Name	Type	Required	Description
name	string	Required	The new label for the segment. May be up to 64 characters. Segment names are unique per project and case-insensitive.

Response

The segment object

Field	Type	Description
id	integer	The unique ID of the segment.
project_id	integer	The ID of the project this segment belongs to.
name	string	The display label of the segment.
created_at	datetime	When the segment was created.
updated_at	datetime	When the segment was last updated.

curl -X PUT https://pineprompt.com/api/v1/segments/7 \ -H "Authorization: Bearer $PINEPROMPT_TOKEN" \ -H "Pineprompt-Project-Id: 1" \ -H "Content-Type: application/json" \ -d '{ "name": "Enterprise Competitors" }'

import os import requests response = requests.put( "https://pineprompt.com/api/v1/segments/7", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", "Content-Type": "application/json", }, json={ "name": "Enterprise Competitors", }, ) response.raise_for_status() payload = response.json()

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