API
Edit Importer
API
Edit Importer
Edit an importer
PUT
/
importer
/
{id}
curl --request PUT \
--url https://api.tableflow.com/v1/importer/{id} \
--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": false,
"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": false,
"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
Example:
"6de452a2-bd1f-4cb3-b29b-0f8a2e3d9353"
Example:
"Test Importer"
Example:
"The first name"
Example:
"a1ed136d-33ce-4b7e-a7a4-8a5ccfe54cd5"
Example:
"email"
Example:
"First Name"
Example:
false
Example:
["first_name"]
Example:
4581
Example:
"This column must contain a value"
Example:
"error"
Example:
"filled"
Example:
"true"
Example:
"f0797968-becc-422a-b135-19de1d8c5d46"
Example:
"My Template"
Response
200
application/json
OK
Example:
"6de452a2-bd1f-4cb3-b29b-0f8a2e3d9353"
Example:
"Test Importer"
Example:
"The first name"
Example:
"a1ed136d-33ce-4b7e-a7a4-8a5ccfe54cd5"
Example:
"email"
Example:
"First Name"
Example:
false
Example:
["first_name"]
Example:
4581
Example:
"This column must contain a value"
Example:
"error"
Example:
"filled"
Example:
"true"
Example:
"f0797968-becc-422a-b135-19de1d8c5d46"
Example:
"My Template"
curl --request PUT \
--url https://api.tableflow.com/v1/importer/{id} \
--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": false,
"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": false,
"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"
}
}