Segments

Update a segment name

PUT
/api/v1/envs/{envId}/segments/{segmentId}/name

Update the display name of an existing segment.

Authorization

AccessToken
Authorization<token>

Use access token to access this API. Example: "Authorization: api-MzQ..."

In: header

Path Parameters

segmentId*string
Formatuuid
envId*string

Header Parameters

Organization?string

The organization ID associated with the request. Some APIs require this header to identify the organization context. When authenticating with an Access Token, this header is automatically populated from the token and does not need to be provided manually.

Workspace?string

The workspace ID associated with the request. Some APIs require this header to identify the workspace context. When authenticating with an Access Token, this header is automatically populated from the token and does not need to be provided manually.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/api/v1/envs/string/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08/name" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "errors": [    "string"  ],  "data": true}