> ## Documentation Index > Fetch the complete documentation index at: https://docs.ouraicalling.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a segment > Partial update — only the provided fields change. **Required scope:** `segments:write` (the legacy `calls:write` scope is also accepted; keys without scope restrictions have full access). ## OpenAPI ````yaml /api-reference/openapi.json patch /segments/{id} openapi: 3.1.0 info: title: OurAiCalling API version: 1.0.0 description: >- REST API for OurAiCalling. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. Everything documented here is also exposed as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials and permission model. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs and external MCP servers) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and minutes ledger of the key owner. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Plan gate: automation_platform. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires the custom_dashboards plan feature. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage the customers of your white-label workspace on their behalf — list, register, mint access tokens, log in, log out, and transfer credits. Available to reseller workspaces with white-label access, and to platform admins (scoped to direct platform customers). Requires `platform:read` / `platform:write`. - name: API Keys description: >- Self-service API keys for the calling workspace. A key can only mint further keys with a scope subset of its own. - name: SMS description: Outbound SMS from workspace phone numbers. paths: /segments/{id}: parameters: - name: id in: path required: true schema: type: string format: uuid description: Segment ID. patch: tags: - Segments summary: Update a segment description: >- Partial update — only the provided fields change. **Required scope:** `segments:write` (the legacy `calls:write` scope is also accepted; keys without scope restrictions have full access). operationId: updateSegment requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SegmentInput' example: name: Not yet reached (this week) responses: '200': description: The updated segment. content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/Segment' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' components: schemas: SegmentInput: type: object description: >- Create: `name` is required. Update (PATCH): all fields optional, only provided fields change. properties: name: type: string minLength: 1 description: type: - string - 'null' filters: $ref: '#/components/schemas/SegmentFilters' Segment: type: object properties: id: type: string format: uuid name: type: string description: type: - string - 'null' filters: $ref: '#/components/schemas/SegmentFilters' created_by: type: - string - 'null' format: uuid created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - name - filters - created_at - updated_at SegmentFilters: type: object description: >- Filter definition. Empty/omitted = "All Leads" (no filter). Every field is optional and ANDed together. properties: search: type: string description: >- Free-text search, matched against lead phone number and name (substring, case-insensitive). display_status: type: array items: type: string enum: - created - processing - rescheduled - max_retries - completed - dnc description: Only leads whose derived display status is one of these. campaign_id: type: - string - 'null' description: >- Campaign UUID to filter by, the literal string "none" for leads without a campaign, or null/omitted for no filter. dnc: type: boolean description: >- true = only leads on the Do-Not-Call list; false = exclude those leads; omitted = do not filter by DNC status. channels: type: array uniqueItems: true items: type: string enum: - call - sms - email - whatsapp - telegram - messenger - slack - teams - discord - gchat - x description: >- Contacts with activity or a profile on any selected channel. Values are ORed within this field and ANDed with the other filters. sources: type: array uniqueItems: true maxItems: 32 items: type: string maxLength: 80 description: Contacts originating from any selected source tag. Values are ORed. tags: type: array uniqueItems: true maxItems: 32 items: type: string maxLength: 80 description: Contacts containing any selected tag. Values are ORed. created_at: type: object description: Inclusive contact-created timestamp range. properties: from: type: string format: date-time to: type: string format: date-time attempts: type: object description: Inclusive outbound call-attempt range. properties: min: type: integer minimum: 0 maximum: 100000 max: type: integer minimum: 0 maximum: 100000 amd_results: type: array uniqueItems: true items: type: string enum: - human - uncertain - machine-vm - machine-ivr - machine-unavailable - none description: >- Last answering-machine-detection result. `none` matches contacts without a result. qa: type: object required: - window description: >- Dynamic Call QA average filter. Contacts without scored calls are excluded; without an explicit sample minimum at least one scored call is required. properties: window: oneOf: - type: integer enum: - 7 - 30 - 90 - type: string enum: - all average_score_min: type: number minimum: 0 maximum: 100 average_score_max: type: number minimum: 0 maximum: 100 min_scored_calls: type: integer minimum: 1 ErrorEnvelope: type: object description: Error envelope returned by every /api/v1 endpoint on failure. required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - not_found - invalid_request - rate_limited - conflict - telephony_configuration_error - telephony_unavailable - internal_error description: Stable, machine-readable error code. message: type: string description: Human-readable description of the error. responses: BadRequest: description: Invalid request body or parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_request message: '"to_number" is required (E.164 format, e.g. +4930123456).' Unauthorized: description: Missing, invalid, expired or revoked API key / access token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized message: Invalid API key. Forbidden: description: >- The API key lacks the required scope, or the plan does not allow this action. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: forbidden message: This API key is missing the required scope "assistants:write". NotFound: description: Resource not found (or it belongs to another workspace). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not_found message: Assistant not found Conflict: description: The resource is in a conflicting state. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: conflict message: Campaign is not running. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- 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. ````