Google Sheets

Update a destination spreadsheet

Update the spreadsheet's display name, tab assignments, or column configuration. When the column configuration changes, previously synced rows are reformatted to the new layout asynchronously.

PUT

/destinations/google-sheets/connections/{connectionId}/sheets/{sheetId}

curl --request PUT \
  --url https://api.synci.io/api/v1/destinations/google-sheets/connections/{connectionId}/sheets/{sheetId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "balance_history_sheet_gid": "<string>",
    "balance_history_sheet_name": "<string>",
    "connection": {
      "auth_url": "<string>",
      "created_at": "<string>",
      "enabled": "<string>",
      "google_email": "<string>",
      "health": {
        "failure_count": "<string>",
        "integrator_message": "<string>",
        "last_attempt_at": "<string>",
        "status": "<string>",
        "transient_failure_count": "<string>",
        "transient_message": "<string>"
      },
      "id": "<string>",
      "last_synced_at": "<string>",
      "name": "<string>",
      "sheets": [
        {}
      ],
      "updated_at": "<string>"
    },
    "connection_id": "<string>",
    "created_at": "<string>",
    "health": {
      "failure_count": "<string>",
      "integrator_message": "<string>",
      "last_attempt_at": "<string>",
      "status": "<string>",
      "transient_failure_count": "<string>",
      "transient_message": "<string>"
    },
    "id": "<string>",
    "is_synci_managed": "<string>",
    "last_synced_at": "<string>",
    "live_balance_sheet_gid": "<string>",
    "live_balance_sheet_name": "<string>",
    "name": "<string>",
    "spreadsheet_id": "<string>",
    "spreadsheet_name": "<string>",
    "spreadsheet_url": "<string>",
    "transactions_sheet_gid": "<string>",
    "transactions_sheet_name": "<string>",
    "transfer_links": [
      {
        "active": "<string>",
        "created_at": "<string>",
        "destination": {
          "balance": "<string>",
          "budget": {
            "accounts": [
              {}
            ],
            "connection": {
              "auth_url": "<string>",
              "budgets": [
                {}
              ],
              "created_at": "<string>",
              "enabled": "<string>",
              "health": {
                "failure_count": "<string>",
                "integrator_message": "<string>",
                "last_attempt_at": "<string>",
                "status": "<string>",
                "transient_failure_count": "<string>",
                "transient_message": "<string>"
              },
              "id": "<string>",
              "last_synced_at": "<string>",
              "name": "<string>",
              "sync_balances": "<string>",
              "updated_at": "<string>",
              "ynab_user_id": "<string>"
            },
            "connection_id": "<string>",
            "created_at": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionIdintegerrequired

The Google Sheets connection ID

sheetIdintegerrequired

The Google Sheet ID

Body

balance_history_sheet_gidinteger | null

The gid of the tab that records balance history. Must be sent together with balance_history_sheet_name; send both as null to clear.

balance_history_sheet_namestring | null

The name of the tab that records balance history. Must be sent together with balance_history_sheet_gid.

Maximum string length: 255

header_configenum<string>[]

Ordered list of transaction field keys to use as spreadsheet columns. Changing this reformats previously synced rows to the new layout.

Minimum array length: 1

live_balance_sheet_gidinteger | null

The gid of the tab that holds current balances. Must be sent together with live_balance_sheet_name; send both as null to clear.

live_balance_sheet_namestring | null

The name of the tab that holds current balances. Must be sent together with live_balance_sheet_gid.

Maximum string length: 255

namestring | null

Display name for the spreadsheet in Synci.

Maximum string length: 255

transactions_sheet_gidinteger | null

The gid of the tab that receives transactions. Must be sent together with transactions_sheet_name; send both as null to clear.

transactions_sheet_namestring | null

The name of the tab that receives transactions. Must be sent together with transactions_sheet_gid.

Maximum string length: 255

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team