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

# Sync the live sheet now

**Required scope:** `intel.view`, and API keys additionally need `campaigns.edit`.

<Note>Requires a plan that includes business intelligence (basic tier). Otherwise the request is refused; see [Errors](/concepts/errors).</Note>


## OpenAPI

````yaml /api-reference/openapi.json post /campaigns/{id}/sheet/sync
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /campaigns/{id}/sheet/sync:
    post:
      summary: Sync the live sheet now
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  connected:
                    type: boolean
                  googleEmail:
                    type: string
                    nullable: true
                  linked:
                    type: boolean
                  spreadsheetUrl:
                    type: string
                    nullable: true
                  source:
                    type: string
                    nullable: true
                    enum:
                      - GENERATED
                      - ATTACHED
                  status:
                    type: string
                    nullable: true
                    enum:
                      - ACTIVE
                      - PAUSED
                      - ERROR
                  autoSync:
                    type: boolean
                  matchColumn:
                    type: string
                    nullable: true
                  lastSyncedAt:
                    type: string
                    nullable: true
                  lastError:
                    type: string
                    nullable: true
                  legacyLayout:
                    type: boolean
                  managedColumnCount:
                    type: integer
                  layoutLocked:
                    type: boolean
                  sheetTitle:
                    type: string
                    nullable: true
                  sheetGid:
                    type: integer
                    nullable: true
                  previousSpreadsheetUrl:
                    type: string
                    nullable: true
                  rotatedAt:
                    type: string
                    nullable: true
                required:
                  - connected
                  - googleEmail
                  - linked
                  - spreadsheetUrl
                  - source
                  - status
                  - autoSync
                  - matchColumn
                  - lastSyncedAt
                  - lastError
                  - legacyLayout
                  - managedColumnCount
                  - layoutLocked
                  - sheetTitle
                  - sheetGid
                  - previousSpreadsheetUrl
                  - rotatedAt
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `feature_not_available`: This feature is not enabled for your
            workspace or plan.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.