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

# Sync country rules from an upstream regulatory feed

> Refresh the global country × channel regulatory table from an upstream feed (Telnyx coverage, MEF SenderID Registry, GSMA SMS Hub, iconectiv TCR, Meta WABA, or ITU WTID). Use it to pull the latest structural coverage — country name, calling code, region, and permitted sender types — for one channel; ops free-text such as sender rules and content restrictions is never overwritten by a sync. Platform-admin only, because it mass-refreshes a table every tenant reads and may hit paid upstream feeds. Returns the row counts touched so the admin can see exactly what changed.



## OpenAPI

````yaml /openapi.yaml post /api/v1/compliance/country-rules/sync
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/compliance/country-rules/sync:
    post:
      tags:
        - Compliance
      summary: Sync country rules from an upstream regulatory feed
      description: >-
        Refresh the global country × channel regulatory table from an upstream
        feed (Telnyx coverage, MEF SenderID Registry, GSMA SMS Hub, iconectiv
        TCR, Meta WABA, or ITU WTID). Use it to pull the latest structural
        coverage — country name, calling code, region, and permitted sender
        types — for one channel; ops free-text such as sender rules and content
        restrictions is never overwritten by a sync. Platform-admin only,
        because it mass-refreshes a table every tenant reads and may hit paid
        upstream feeds. Returns the row counts touched so the admin can see
        exactly what changed.
      parameters:
        - in: query
          name: provider
          required: false
          schema:
            type: string
            enum:
              - telnyx
              - mef
              - gsma
              - iconectiv
              - meta
              - itu
            default: telnyx
          description: >-
            Upstream feed to sync from. Defaults to the free Telnyx coverage
            feed.
        - in: query
          name: channel
          required: false
          schema:
            type: string
            enum:
              - sms
              - whatsapp
              - rcs
              - voice
              - email
              - viber
            default: sms
          description: >-
            Channel whose rules to refresh. Each country carries separate rows
            per channel.
      responses:
        '200':
          description: >-
            Sync completed; the counts report how many rows were created or
            updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      synced_at:
                        type: string
                        format: date-time
                        description: When the sync ran.
                      provider:
                        type: string
                        description: Feed the rows were synced from.
                      channel:
                        type: string
                        description: Channel that was refreshed.
                      upstreamCount:
                        type: integer
                        description: Number of rows the upstream feed returned.
                      updated:
                        type: integer
                        description: Existing rows refreshed in place.
                      createdNew:
                        type: integer
                        description: New country rows inserted.
                      errors:
                        type: array
                        items:
                          type: string
                        description: >-
                          Non-fatal upstream errors; the sync fails open and
                          reports them here rather than aborting.
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  synced_at: '2026-08-07T12:00:00.000Z'
                  provider: telnyx
                  channel: sms
                  upstreamCount: 240
                  updated: 236
                  createdNew: 4
                  errors: []
                meta:
                  request_id: req_1a2b3c4d5e6f
                  timestamp: '2026-08-07T12:00:00.000Z'
        '403':
          description: Platform-admin only — the caller is not a Devotel platform admin.
components:
  schemas:
    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_*)

````