Skip to main content
POST
Generate or attach a live Google Sheet
Required scope: intel.view, and API keys additionally need campaigns.edit.
Requires a plan that includes business intelligence (basic tier). Otherwise the request is refused; see Errors.

Authorizations

Authorization
string
header
required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id
string
required

Body

application/json
mode
enum<string>
required
Available options:
generate,
attach
spreadsheetUrl
string
sheetGid
integer
matchColumn
string
configuration
object

Response

Created

connected
boolean
required
googleEmail
string | null
required
linked
boolean
required
spreadsheetUrl
string | null
required
source
enum<string> | null
required
Available options:
GENERATED,
ATTACHED
status
enum<string> | null
required
Available options:
ACTIVE,
PAUSED,
ERROR
autoSync
boolean
required
matchColumn
string | null
required
lastSyncedAt
string | null
required
lastError
string | null
required
legacyLayout
boolean
required
managedColumnCount
integer
required
layoutLocked
boolean
required
sheetTitle
string | null
required
sheetGid
integer | null
required
previousSpreadsheetUrl
string | null
required
rotatedAt
string | null
required