> ## 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 the BigQuery reverse-ETL config

> Merge-update the tenant's BigQuery reverse-ETL configuration. Only the keys you send are changed; omitted keys are left untouched, and a `PATCH {}` is a no-op that returns the current config. Set `service_account_json` to rotate the destination credentials — it is validated and encrypted at rest, never stored or returned in plaintext — or send an empty string to clear it. Scheduler-managed run-status fields (last_run_*, last_error_*, consecutive_failures) cannot be written here. Owner / admin only.



## OpenAPI

````yaml /openapi.yaml patch /api/v1/cdp/reverse-etl
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/cdp/reverse-etl:
    patch:
      tags:
        - CDP
      summary: Update the BigQuery reverse-ETL config
      description: >-
        Merge-update the tenant's BigQuery reverse-ETL configuration. Only the
        keys you send are changed; omitted keys are left untouched, and a `PATCH
        {}` is a no-op that returns the current config. Set
        `service_account_json` to rotate the destination credentials — it is
        validated and encrypted at rest, never stored or returned in plaintext —
        or send an empty string to clear it. Scheduler-managed run-status fields
        (last_run_*, last_error_*, consecutive_failures) cannot be written here.
        Owner / admin only.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Turn the nightly reverse-ETL sync on or off.
                export_messages:
                  type: boolean
                  description: Also mirror the `messages` delta to the destination dataset.
                export_conversations:
                  type: boolean
                  description: Also mirror the `conversations` delta.
                export_usage_events:
                  type: boolean
                  description: Also mirror the rated-usage `usage_events` delta.
                export_call_logs:
                  type: boolean
                  description: Also mirror the voice CDR `call_logs` delta.
                sync_interval_minutes:
                  type: integer
                  description: >-
                    Sync cadence in minutes; omit to keep the default 23h
                    nightly cadence.
                project_id:
                  type: string
                  description: >-
                    Destination BigQuery project id (6–30 chars, lowercase
                    letters / digits / hyphens, starts with a letter).
                dataset_id:
                  type: string
                  description: >-
                    Destination BigQuery dataset id (letters / digits /
                    underscores).
                table_prefix:
                  type: string
                  description: Prefix applied to every destination table name.
                service_account_json:
                  type: string
                  description: >-
                    Service-account JSON for the destination project (must
                    contain `client_email` and `private_key`). Encrypted at
                    rest; send an empty string to clear.
                field_mappings:
                  type:
                    - 'null'
                    - object
                  additionalProperties: true
                  description: >-
                    Per-table column exclusion / rename / computed map; pass
                    null to clear and export every column.
            examples:
              enable:
                summary: Point the export at a dataset and enable it
                value:
                  enabled: true
                  project_id: acme-analytics
                  dataset_id: orbit_cdp
                  table_prefix: orbit_
                  sync_interval_minutes: 360
              addMessageMirror:
                summary: Opt the message logs into the mirror
                value:
                  export_messages: true
                  export_conversations: true
      responses:
        '200':
          description: The updated BigQuery reverse-ETL configuration.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CdpReverseEtlConfig'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          description: Invalid config — malformed service_account_json or field_mappings.
components:
  schemas:
    CdpReverseEtlConfig:
      type: object
      description: >-
        Tenant BigQuery reverse-ETL configuration. The stored service-account
        JSON is never returned in plaintext — `service_account_configured`
        reports whether one is set.
      properties:
        enabled:
          type: boolean
          description: Whether the nightly reverse-ETL sync is active for this tenant.
        export_messages:
          type: boolean
          description: >-
            Opt-in — also mirror the `messages` delta to the destination
            dataset.
        export_conversations:
          type: boolean
          description: >-
            Opt-in — also mirror the `conversations` delta to the destination
            dataset.
        export_usage_events:
          type: boolean
          description: Opt-in — also mirror the rated-usage `usage_events` delta.
        export_call_logs:
          type: boolean
          description: Opt-in — also mirror the voice CDR `call_logs` delta.
        sync_interval_minutes:
          type:
            - 'null'
            - integer
          description: >-
            Configured sync cadence in minutes; null when on the default 23h
            nightly cadence.
        project_id:
          type:
            - 'null'
            - string
          description: Destination BigQuery project id.
        dataset_id:
          type:
            - 'null'
            - string
          description: Destination BigQuery dataset id.
        table_prefix:
          type:
            - 'null'
            - string
          description: Prefix applied to every destination table name.
        service_account_configured:
          type: boolean
          description: >-
            True when an encrypted service-account JSON is currently stored. The
            plaintext is never returned.
        field_mappings:
          type:
            - 'null'
            - object
          additionalProperties: true
          description: >-
            Per-table column exclusion / rename / computed map; null when every
            column is exported.
        last_run_at:
          type:
            - 'null'
            - string
          format: date-time
          description: >-
            ISO 8601 timestamp of the most recent sync run; null before the
            first run.
        last_run_status:
          type:
            - 'null'
            - string
          enum:
            - ok
            - failed
            - null
          description: Outcome of the most recent sync run.
        last_run_rows_contacts:
          type:
            - 'null'
            - integer
          description: Rows written to the contacts table on the last run.
        last_run_rows_events:
          type:
            - 'null'
            - integer
          description: Rows written to the cdp_events table on the last run.
        last_run_rows_messages:
          type:
            - 'null'
            - integer
          description: Rows written to the messages table on the last run.
        last_run_rows_conversations:
          type:
            - 'null'
            - integer
          description: Rows written to the conversations table on the last run.
        last_run_rows_usage_events:
          type:
            - 'null'
            - integer
          description: Rows written to the usage_events table on the last run.
        last_run_rows_call_logs:
          type:
            - 'null'
            - integer
          description: Rows written to the call_logs table on the last run.
        last_error:
          type:
            - 'null'
            - string
          description: >-
            Error message from the most recent failed run; null when the last
            run succeeded.
        last_error_at:
          type:
            - 'null'
            - string
          format: date-time
          description: ISO 8601 timestamp of the most recent failure.
        consecutive_failures:
          type:
            - 'null'
            - integer
          description: Count of consecutive failed runs; resets to 0 on a successful run.
    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
  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_*)

````