> ## 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.

# Replace the org's selective-recording policy

> Replaces the org's recording policy (whole-document upsert). The policy is persisted as a sub-key of the existing `organizations.settings.recording` blob, preserving sibling keys (retention_days, eligibility_mode, consent_announcement_mode, …). Rule ids must be unique. Admin-only.



## OpenAPI

````yaml /openapi.yaml put /api/v1/voice/recording-policy
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
paths:
  /api/v1/voice/recording-policy:
    put:
      tags:
        - Voice
      summary: Replace the org's selective-recording policy
      description: >-
        Replaces the org's recording policy (whole-document upsert). The policy
        is persisted as a sub-key of the existing
        `organizations.settings.recording` blob, preserving sibling keys
        (retention_days, eligibility_mode, consent_announcement_mode, …). Rule
        ids must be unique. Admin-only.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - rules
              properties:
                enabled:
                  type: boolean
                  description: >-
                    Master on/off for the policy engine. Defaults to true when
                    omitted.
                defaultRecordPercent:
                  type: number
                  minimum: 0
                  maximum: 100
                  nullable: true
                  description: >-
                    Deterministic sampling percentage applied when no rule
                    matches.
                rules:
                  type: array
                  maxItems: 200
                  items:
                    $ref: '#/components/schemas/VoiceRecordingPolicyRuleInput'
      responses:
        '200':
          description: The normalised, persisted recording policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/VoiceRecordingPolicy'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          description: Invalid recording policy or duplicate rule id
components:
  schemas:
    VoiceRecordingPolicyRuleInput:
      type: object
      required:
        - id
        - name
        - priority
        - conditions
        - action
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 120
        name:
          type: string
          minLength: 1
          maxLength: 200
        priority:
          type: integer
          minimum: 0
          maximum: 1000000
          description: Higher priority wins; ties broken by id.
        conditions:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/VoiceRecordingPolicyCondition'
        action:
          type: string
          enum:
            - record
            - skip
        samplePercent:
          type: number
          minimum: 0
          maximum: 100
          description: >-
            Deterministic sampling percentage applied when this rule matches.
            Defaults to 100.
        requireTwoPartyConsent:
          type: boolean
        enabled:
          type: boolean
    VoiceRecordingPolicy:
      type: object
      description: >-
        Normalised, fully-populated recording policy as returned on the wire
        (snake_case projection).
      properties:
        enabled:
          type: boolean
        default_record_percent:
          type: number
          nullable: true
          minimum: 0
          maximum: 100
        rules:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              priority:
                type: integer
              action:
                type: string
                enum:
                  - record
                  - skip
              sample_percent:
                type: number
              require_two_party_consent:
                type: boolean
              enabled:
                type: boolean
              conditions:
                type: array
                items:
                  $ref: '#/components/schemas/VoiceRecordingPolicyCondition'
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
    VoiceRecordingPolicyCondition:
      type: object
      required:
        - signal
        - op
        - value
      properties:
        signal:
          type: string
          enum:
            - queue
            - skill
            - agent
            - direction
            - consent_state
            - country
            - region
          description: The call attribute the condition predicates on.
        op:
          type: string
          enum:
            - eq
            - ne
            - in
            - not_in
          description: >-
            Comparison operator. `eq`/`ne` take a scalar; `in`/`not_in` take an
            array.
        value:
          description: A scalar string (for eq/ne) or an array of strings (for in/not_in).
          oneOf:
            - type: string
              minLength: 1
              maxLength: 200
            - type: array
              minItems: 1
              maxItems: 200
              items:
                type: string
                minLength: 1
                maxLength: 200
  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_*)

````