onSchemaError
query parameter.
Examples
Create Table w/ Row Data
Create Table w/ Row Data
rows
field (being sure that row object structure matches the table schema):Create Table from Stash
Create Table from Stash
$stashID
reference in the rows
field instead of providing the data inline:Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Name of the table. Required when the name is not passed in the request body. It is an error to pass a name in both this query parameter and the request body.
"Invoices"
An array of app IDs to link the new table to.
The action to take when the passed data does not match the table schema:
abort
: Abort the entire operation and return an error.dropColumns
: Ignore the data that caused the error, and do not import those columns in the affected rows.updateSchema
: Update the schema as needed to add any missing columns or widen the data types of existing columns, and then import the data from them.
abort
, dropColumns
, updateSchema
"updateSchema"
Body
Name of the table, e.g., Invoices
"Invoices"
A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:
[
{
"fullName": "Alex Bard",
"invoiceDate": "2024-07-29T14:04:15.561Z",
"totalAmount": 34.50,
"amountPaid": 0
},
{
"fullName": "Alicia Hines",
"invoiceDate": "2023-06-15T10:30:00.000Z",
"totalAmount": 50.75,
"amountPaid": 20
}
]
[
{
"fullName": "Alex Bard",
"invoiceDate": "2024-07-29T14:04:15.561Z",
"totalAmount": 34.5,
"amountPaid": 0
},
{
"fullName": "Alicia Hines",
"invoiceDate": "2023-06-15T10:30:00.000Z",
"totalAmount": 50.75,
"amountPaid": 20
}
]
The schema of the table as a collection of column definitions. If this is not provided, the schema will be inferred from the data.
{
"columns": [
{
"id": "fullName",
"displayName": "Full Name",
"type": "string"
},
{
"id": "invoiceDate",
"displayName": "Invoice Date",
"type": "dateTime"
},
{
"id": "totalAmount",
"displayName": "Total",
"type": "number"
},
{
"id": "amountPaid",
"displayName": "Paid",
"type": "number"
}
]
}
An array of app IDs to link the new table to.