Skip to content

Create Workbench Table

POST
/workbench/tables

Create an empty table.

entity_type decides what the rows become on export and is settable here, at creation - which is why the update model does not offer it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
description
Any of:
string
entity_type
Any of:
string
Allowed values: contact company
name
required

Table name.

string
>= 1 characters

Responses

201

Successful Response

object
data
required

One staging table.

object
created_at
Any of:
string format: date-time
description
Any of:
string
entity_type
Any of:
string
id
Any of:
string
name
Any of:
string
row_count
Any of:
integer
updated_at
Any of:
string format: date-time
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string