> ## 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. # Update a contact segment > Edit a contact segment's name, description, rule definition (the `filters` AST or the legacy `rules` shape) or auto-refresh cadence. Changing the rule definition re-materialises membership immediately — so the contact count and members are live without waiting for the refresh scheduler — and snapshots the superseded definition so the edit can be rolled back from the definition history. ## OpenAPI ````yaml /openapi.yaml put /api/v1/contacts/segments/{id} 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/segments/{id}: put: tags: - Contacts summary: Update a contact segment description: >- Edit a contact segment's name, description, rule definition (the `filters` AST or the legacy `rules` shape) or auto-refresh cadence. Changing the rule definition re-materialises membership immediately — so the contact count and members are live without waiting for the refresh scheduler — and snapshots the superseded definition so the edit can be rolled back from the definition history. parameters: - schema: type: string in: path name: id required: true requestBody: content: application/json: schema: type: object additionalProperties: true properties: name: type: string description: New display name (1-200 chars). description: type: string description: New description (up to 1000 chars). filters: type: object additionalProperties: true description: AND/OR filter AST that defines the segment's membership. rules: type: object additionalProperties: true description: >- Legacy `{ operator, conditions }` rule shape, still accepted for backwards compatibility. auto_refresh: type: boolean description: >- Whether the scheduler re-materialises membership automatically. auto_refresh_interval_minutes: type: integer description: Per-segment refresh cadence in minutes (1-1440). examples: - name: High-value EU customers auto_refresh: true filters: op: AND conditions: - field: lifecycle_stage op: equals value: customer - field: country_code op: equals value: DE responses: '200': description: >- The updated segment, wrapped in the standard `{ data, meta }` envelope. content: application/json: schema: type: object additionalProperties: true properties: data: type: object additionalProperties: true meta: type: object additionalProperties: true 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_*) ````