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

# Run an on-demand CRM object sync

> Maps each supplied profile through the stored field map into a destination object record (keyed on the upsert identifier — profiles with no key value are skipped, never blind-inserted), batches it, and upserts each batch into the SaaS app via Nango when a connection is wired. The run is appended to a capped sync-run history. Owner / admin / developer only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/cdp/crm-sync/run/{destination}
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/cdp/crm-sync/run/{destination}:
    post:
      tags:
        - CDP
      summary: Run an on-demand CRM object sync
      description: >-
        Maps each supplied profile through the stored field map into a
        destination object record (keyed on the upsert identifier — profiles
        with no key value are skipped, never blind-inserted), batches it, and
        upserts each batch into the SaaS app via Nango when a connection is
        wired. The run is appended to a capped sync-run history. Owner / admin /
        developer only.
      parameters:
        - in: path
          name: destination
          required: true
          schema:
            type: string
            enum:
              - salesforce
              - hubspot
              - braze
              - iterable
              - customer_io
              - klaviyo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CdpCrmSyncRunRequest'
      responses:
        '200':
          description: The recorded sync run
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CdpCrmSyncRun'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '409':
          description: >-
            Destination not enabled, field map not configured, or stored map
            invalid
components:
  schemas:
    CdpCrmSyncRunRequest:
      type: object
      description: >-
        On-demand object-sync request. The destination, object type and field
        map come from the URL param + stored config, never the body.
      required:
        - segment_id
        - profiles
      additionalProperties: false
      properties:
        segment_id:
          type: string
          minLength: 1
          maxLength: 200
        profiles:
          type: array
          minItems: 1
          maxItems: 5000
          description: >-
            Source profiles — each an arbitrary bag of traits keyed by source
            path. Profiles missing the upsert key are skipped, never
            blind-inserted.
          items:
            type: object
            additionalProperties: true
    CdpCrmSyncRun:
      type: object
      description: >-
        A recorded CRM object-sync run (counts only — never the profile records
        / PII).
      properties:
        id:
          type: string
          format: uuid
        ts:
          type: string
          format: date-time
        destination:
          type: string
          enum:
            - salesforce
            - hubspot
            - braze
            - iterable
            - customer_io
            - klaviyo
        object_type:
          type: string
        segment_id:
          type: string
        requested:
          type: integer
        matched:
          type: integer
        skipped:
          type: integer
        batches:
          type: integer
        dispatched:
          type: integer
        dispatch_skipped:
          type: integer
        status:
          type: string
          enum:
            - ok
            - partial
            - failed
            - skipped
        error:
          type:
            - 'null'
            - string
    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_*)

````