API
Create Importer
API
Create Importer
Create an importer
POST
/
importer
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
object
*
id
string
id
string
Add Example Value
name
string
name
string
Add Example Value
template
object
template
object
columns
array
columns
array
id
string
id
string
Add Example Value
name
string
name
string
Add Example Value
curl --request POST \
--url https://api.tableflow.com/v1/importer \
--header 'Content-Type: application/json' \
--data '{
"id": "6de452a2-bd1f-4cb3-b29b-0f8a2e3d9353",
"name": "Test Importer",
"template": {
"columns": [
{
"description": "The first name",
"id": "a1ed136d-33ce-4b7e-a7a4-8a5ccfe54cd5",
"key": "email",
"name": "First Name",
"required": true,
"suggested_mappings": [
"first_name"
],
"validations": [
{
"id": 4581,
"message": "This column must contain a value",
"severity": "error",
"type": "filled",
"value": "true"
}
]
}
],
"id": "f0797968-becc-422a-b135-19de1d8c5d46",
"name": "My Template"
}
}'
{
"id": "6de452a2-bd1f-4cb3-b29b-0f8a2e3d9353",
"name": "Test Importer",
"template": {
"columns": [
{
"description": "The first name",
"id": "a1ed136d-33ce-4b7e-a7a4-8a5ccfe54cd5",
"key": "email",
"name": "First Name",
"required": true,
"suggested_mappings": [
"first_name"
],
"validations": [
{
"id": 4581,
"message": "This column must contain a value",
"severity": "error",
"type": "filled",
"value": "true"
}
]
}
],
"id": "f0797968-becc-422a-b135-19de1d8c5d46",
"name": "My Template"
}
}
Example Request
{
"name": "API Test Importer",
"template": {
"columns": [
{
"name": "First Name",
"key": "first_name",
"required": false,
"description": "The first name of the user",
"suggested_mappings": [
"First",
"Name"
]
},
{
"name": "Last Name"
},
{
"name": "Email",
"required": true,
"description": "The email of the user"
}
]
}
}
Body
application/json
id
string
name
string
template
object
template.columns
object[]
template.columns.description
string
template.columns.id
string
template.columns.key
string
template.columns.name
string
template.columns.required
boolean
template.columns.suggested_mappings
string[]
template.columns.validations
object[]
template.columns.validations.id
integer
template.columns.validations.message
string
template.columns.validations.severity
string
template.columns.validations.type
string
template.columns.validations.value
string
template.id
string
template.name
string
Response
200 - application/json
id
string
name
string
template
object
template.columns
object[]
template.columns.description
string
template.columns.id
string
template.columns.key
string
template.columns.name
string
template.columns.required
boolean
template.columns.suggested_mappings
string[]
template.columns.validations
object[]
template.columns.validations.id
integer
template.columns.validations.message
string
template.columns.validations.severity
string
template.columns.validations.type
string
template.columns.validations.value
string
template.id
string
template.name
string
curl --request POST \
--url https://api.tableflow.com/v1/importer \
--header 'Content-Type: application/json' \
--data '{
"id": "6de452a2-bd1f-4cb3-b29b-0f8a2e3d9353",
"name": "Test Importer",
"template": {
"columns": [
{
"description": "The first name",
"id": "a1ed136d-33ce-4b7e-a7a4-8a5ccfe54cd5",
"key": "email",
"name": "First Name",
"required": true,
"suggested_mappings": [
"first_name"
],
"validations": [
{
"id": 4581,
"message": "This column must contain a value",
"severity": "error",
"type": "filled",
"value": "true"
}
]
}
],
"id": "f0797968-becc-422a-b135-19de1d8c5d46",
"name": "My Template"
}
}'
{
"id": "6de452a2-bd1f-4cb3-b29b-0f8a2e3d9353",
"name": "Test Importer",
"template": {
"columns": [
{
"description": "The first name",
"id": "a1ed136d-33ce-4b7e-a7a4-8a5ccfe54cd5",
"key": "email",
"name": "First Name",
"required": true,
"suggested_mappings": [
"first_name"
],
"validations": [
{
"id": 4581,
"message": "This column must contain a value",
"severity": "error",
"type": "filled",
"value": "true"
}
]
}
],
"id": "f0797968-becc-422a-b135-19de1d8c5d46",
"name": "My Template"
}
}