Skip to main content
create_worksheet

Authorizations

Authorization
string
header
required

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

Body

application/json
tableId
string
required

Source Rippit table id: a custom data table or a worksheet.

Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]+$
title
string

Worksheet display name; defaults to "Untitled Worksheet".

Maximum string length: 200
where
object[]

Filters on source rows, combined with AND (or_filters groups OR); omitted copies the whole table.

Maximum array length: 20
columnIds
string[]

Source column ids to copy; omitted copies every non-system column. A narrowed list keeps ticket_sid or the column whose kind is external_gradable_reference, or enrichment cannot read the conversations.

Maximum array length: 200
Minimum string length: 1
workbookId
string

Existing workbook for the worksheet; omitted creates a new workbook.

Minimum string length: 1
rowLimit
integer

Keep the N most recent rows by row date after where (an arbitrary N without a row-date column). Not combinable with sampleRows.

Required range: 1 <= x <= 10000
sampleRows
integer

Keep a uniform random sample of N rows drawn after where, fresh on each call. Not combinable with rowLimit.

Required range: 1 <= x <= 10000

Response

200

Tool result.