Google Sheets

Register a destination spreadsheet

Either creates a new Synci-managed spreadsheet (mode=create) or attaches an existing spreadsheet the user selected (mode=attach).

POST

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

curl --request POST \
  --url https://api.synci.io/api/v1/destinations/google-sheets/connections/{connectionId}/sheets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "create"
}
'

<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

Body

header_configenum<string>[] | null

Optional ordered list of transaction field keys to use as spreadsheet columns. Omit to use the default columns.

modeenum<string>required

Use "create" to have Synci create a new spreadsheet in the connected Google Drive, or "attach" to register an existing spreadsheet you own.

Available options: create, attach

namestring | null

Optional display name for the spreadsheet in Synci. Defaults to the spreadsheet title.

Maximum string length: 255

spreadsheet_idstring

The ID of the spreadsheet to attach, as found in its URL. Required when mode is "attach".

Pattern: ^[A-Za-z0-9_-]{20,100}$

Example: 1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms

titlestring | null

Title for the new spreadsheet. Only used when mode is "create".

Maximum string length: 255

Response

bodystring

Still need help? Ask the team