> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Bulk add or remove segment membership

> Add a selected audience to a static segment, or remove them from it, in a single request. Target the audience with either an explicit `contact_ids` array or a `filters` AST — provide exactly one. Membership changes emit the same contact.entered_segment / contact.exited_segment webhooks as the manual path. Large selections are queued and return a job id.



## OpenAPI

````yaml /openapi.yaml post /api/v1/contacts/bulk/segment
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/contacts/bulk/segment:
    post:
      tags:
        - Contacts
      summary: Bulk add or remove segment membership
      description: >-
        Add a selected audience to a static segment, or remove them from it, in
        a single request. Target the audience with either an explicit
        `contact_ids` array or a `filters` AST — provide exactly one. Membership
        changes emit the same contact.entered_segment / contact.exited_segment
        webhooks as the manual path. Large selections are queued and return a
        job id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                contact_ids:
                  type: array
                  items:
                    type: string
                  description: >-
                    Explicit contact ids to target (max 50,000). Provide this OR
                    `filters`.
                filters:
                  type: object
                  additionalProperties: true
                  description: >-
                    Segment filter AST resolving the audience server-side.
                    Provide this OR `contact_ids`.
                segment_id:
                  type: string
                  description: The target segment to add contacts to or remove them from.
                action:
                  type: string
                  enum:
                    - add
                    - remove
                  description: Whether to add the audience to the segment or remove it.
              required:
                - segment_id
                - action
            example:
              contact_ids:
                - contact_01HZX8Y7QJK4M
              segment_id: seg_01HZX8VIP
              action: add
      responses:
        '200':
          description: Membership updated inline.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      queued:
                        type: boolean
                      affected:
                        type: integer
                      total:
                        type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  queued: false
                  affected: 1
                  total: 1
                meta:
                  request_id: req_01HZX9ABCDEF
                  timestamp: '2026-02-02T12:00:00.000Z'
        '202':
          description: >-
            Large selection accepted and queued; poll the returned job id for
            progress.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      queued:
                        type: boolean
                      job_id:
                        type: string
                      total:
                        type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  queued: true
                  job_id: bulkop_01HZX9QJK4M
                  total: 12000
                meta:
                  request_id: req_01HZX9ABCDEF
                  timestamp: '2026-02-02T12:00:00.000Z'
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````