> ## 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 Sync Document

> Replace a Sync Document's `data` (and optionally reset its `ttl`), bumping the revision and fanning out a `document.updated` change event to subscribed WebSocket clients. Requires an operator role.



## OpenAPI

````yaml /openapi.yaml post /api/v1/sync/documents/{name}
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/sync/documents/{name}:
    post:
      tags:
        - Sync
      summary: Update a Sync Document
      description: >-
        Replace a Sync Document's `data` (and optionally reset its `ttl`),
        bumping the revision and fanning out a `document.updated` change event
        to subscribed WebSocket clients. Requires an operator role.
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9._:-]+$
          description: Unique name of the Sync Document.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncDataWrite'
      responses:
        '200':
          description: The updated Sync Document
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SyncDocument'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '404':
          description: No document exists with that unique name
components:
  schemas:
    SyncDataWrite:
      type: object
      required:
        - data
      additionalProperties: false
      description: Write body for updating a Sync Document or setting a Sync Map item.
      properties:
        data:
          $ref: '#/components/schemas/SyncObjectData'
        ttl:
          type: integer
          minimum: 0
          maximum: 31536000
          description: Optional time-to-live in seconds (0 or omitted = no expiry).
    SyncDocument:
      type: object
      required:
        - unique_name
        - data
        - revision
        - date_created
        - date_updated
      additionalProperties: false
      description: >-
        A durable Sync Document — a single JSON object addressed by a unique
        name, carrying a monotonically increasing revision.
      properties:
        unique_name:
          type: string
          description: Tenant-unique name addressing this document.
        data:
          $ref: '#/components/schemas/SyncObjectData'
        revision:
          type: integer
          description: Monotonic revision, incremented on every write.
        date_created:
          type: string
          format: date-time
        date_updated:
          type: string
          format: date-time
    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
    SyncObjectData:
      type: object
      additionalProperties: true
      description: >-
        Arbitrary JSON object payload carried by a Sync object or item. Every
        Sync value is a JSON map (matching Twilio Sync). The serialised payload
        must not exceed 64 KiB.
  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_*)

````