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

# Sync Connection

> Queue an asynchronous sync for a ready connection. Returns `409 conflict` when the connection is still in setup or a sync is already in progress. Returns `429 rate_limited` when a sync was triggered recently and is still in cooldown.



## OpenAPI

````yaml /openapi.json put /v1/connections/{connectionId}/sync
openapi: 3.1.0
info:
  title: Waycore Bank Connections API
  description: >-
    Developer-first API for direct bank connections, accounts, and transactions.


    Design goals:

    - Flat records with minimal nesting.

    - Clear, bank-centric naming.

    - One canonical endpoint per resource.

    - Sparse fieldsets via `fields=`.

    - Historical browsing via `GET /transactions`.

    - Incremental ETL via `GET /transactions/sync`.

    - Discover supported institutions via `GET /institutions`.

    - Model downstream client businesses via `/entities` and explicit `entityId`
    ownership.


    Authentication:

    - Opaque API keys passed as `Authorization: Bearer <key>`.

    - Key format: `way_<environment>_<key_id>_<secret>`.

    - Keys are organization-bound, environment-bound (`live` or `test`),
    scope-carrying, and expiring.

    - Managed via the Waycore Console.
  version: 0.5.0
servers:
  - url: https://api.waycore.com
security: []
paths:
  /v1/connections/{connectionId}/sync:
    put:
      tags:
        - connections
      summary: Sync Connection
      description: >-
        Queue an asynchronous sync for a ready connection. Returns `409
        conflict` when the connection is still in setup or a sync is already in
        progress. Returns `429 rate_limited` when a sync was triggered recently
        and is still in cooldown.
      operationId: sync_connection_v1_connections__connectionId__sync_put
      parameters:
        - name: connectionId
          in: path
          required: true
          schema:
            title: Connectionid
            type: string
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerConnectionSyncResponse'
                type: object
                additionalProperties: true
                title: >-
                  Response Sync Connection V1 Connections  Connectionid  Sync
                  Put
        '400':
          description: >-
            Bad Request. `type` may be `invalid_request` for malformed query
            parameters or validation failures.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Forbidden
        '404':
          description: >-
            Not Found. Returned when the connection does not exist, is not
            public-visible, or is not a connection available through this API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '409':
          description: >-
            Conflict. Returned when the requested state transition is not
            currently allowed, such as syncing a setup-stage connection or when
            an existing connection cannot be represented through the requested
            public contract.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '429':
          description: >-
            Too Many Requests. Retry after the number of seconds in
            `Retry-After` when present, then retry the same request.
          headers:
            Retry-After:
              description: >-
                Number of seconds to wait before retrying, when rate limiting
                provides a specific backoff.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Internal Server Error
      security:
        - apiKeyBearer:
            - connections:write
components:
  schemas:
    TriggerConnectionSyncResponse:
      properties:
        connectionId:
          type: string
          title: Connectionid
          description: Identifier of the connection whose sync was queued.
        meta:
          $ref: '#/components/schemas/app__connections__public__models__Meta'
      type: object
      required:
        - connectionId
        - meta
      title: TriggerConnectionSyncResponse
    PublicErrorResponse:
      properties:
        type:
          title: Type
          type: string
        message:
          type: string
          title: Message
        requestId:
          anyOf:
            - type: string
            - type: 'null'
          title: Requestid
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
      type: object
      required:
        - type
        - message
      title: PublicErrorResponse
    app__connections__public__models__Meta:
      properties:
        requestId:
          type: string
          title: Requestid
      type: object
      required:
        - requestId
      title: Meta
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: way_<environment>_<key_id>_<secret>
      description: >-
        Opaque API key passed as `Authorization: Bearer <key>`. Keys are
        organization-bound, environment-bound (`live` or `test`),
        scope-carrying, and expiring. Create and manage keys via the console.

````