> ## Documentation Index
> Fetch the complete documentation index at: https://docs.social-api.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Start an inbox sync

> Forces a refresh from the platform, bypassing the normal staleness window. With only account_id the job refreshes that account's conversation list; add conversation_id to refresh one thread's messages instead. Returns immediately: poll GET /inbox/sync for progress. Calling this while a sync for the same target is already running returns the running job rather than starting a second one.



## OpenAPI

````yaml /api-reference/openapi.json post /inbox/sync
openapi: 3.0.0
info:
  description: >-
    Unified social media inbox API. Read and respond to comments, DMs, reviews,
    and mentions across Instagram, Facebook, Threads, Google Business Profile,
    TikTok, LinkedIn, and YouTube through a single REST API. X/Twitter and
    Trustpilot coming soon.
  title: SocialAPI.AI
  contact:
    name: SocialAPI.AI Support
    email: support@social-api.ai
  license:
    name: MIT
  version: '1.0'
servers:
  - url: https://api.social-api.ai/v1
security: []
paths:
  /inbox/sync:
    post:
      tags:
        - Inbox
      summary: Start an inbox sync
      description: >-
        Forces a refresh from the platform, bypassing the normal staleness
        window. With only account_id the job refreshes that account's
        conversation list; add conversation_id to refresh one thread's messages
        instead. Returns immediately: poll GET /inbox/sync for progress. Calling
        this while a sync for the same target is already running returns the
        running job rather than starting a second one.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api_endpoints.InboxSyncRequest'
        description: Sync target
        required: true
      responses:
        '202':
          description: Sync started, or already running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.InboxSyncResponse'
        '400':
          description: Missing or invalid account_id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '404':
          description: Account or conversation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '429':
          description: >-
            A sync for this target ran too recently. The Retry-After header
            carries the seconds to wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    api_endpoints.InboxSyncRequest:
      type: object
      properties:
        account_id:
          type: string
          example: acc_01H...
        conversation_id:
          type: string
          example: 6f1c...
    api_endpoints.InboxSyncResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/api_endpoints.InboxSyncStatus'
    api_endpoints.ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/api_endpoints.ErrorBody'
    api_endpoints.InboxSyncStatus:
      type: object
      properties:
        error:
          type: string
          example: ''
        finished_at:
          type: string
        last_synced_at:
          type: string
        started_at:
          type: string
        state:
          description: >-
            State is "idle", "syncing", or "failed". A finished job is idle with
            a

            fresher LastSyncedAt; there is no terminal "done".
          type: string
          enum:
            - idle
            - syncing
            - failed
          example: syncing
        synced:
          description: Synced counts what the last completed job wrote. Display only.
          type: integer
          example: 12
    api_endpoints.ErrorBody:
      type: object
      properties:
        code:
          type: string
          example: resource.not_found
        message:
          type: string
          example: Account not found
        meta:
          type: object
          additionalProperties: {}
  securitySchemes:
    BearerAuth:
      description: >-
        Prefix your API key with "Bearer ". Example: `Authorization: Bearer
        sapi_key_...`
      type: apiKey
      name: Authorization
      in: header

````