Skip to main content
PATCH
Update a segment

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Path Parameters

id
string<uuid>
required

Segment ID.

Body

application/json

Create: name is required. Update (PATCH): all fields optional, only provided fields change.

name
string
Minimum string length: 1
description
string | null
filters
object

Filter definition. Empty/omitted = "All Leads" (no filter). Every field is optional and ANDed together.

Response

The updated segment.

data
object
required