POST
/
schemas
/
Create a new import schema
curl --request POST \
  --url https://app.dromo.io/api/v1/schemas/ \
  --header 'Content-Type: application/json' \
  --header 'X-Dromo-License-Key: <api-key>' \
  --data '{
  "id": "0631f213-ca91-41e0-9a88-7430c7d0ca28",
  "name": "last - email",
  "fields": [
    {
      "key": "lastName",
      "type": "string",
      "label": "last",
      "validators": [
        {
          "validate": "required"
        }
      ]
    },
    {
      "key": "email",
      "type": "email",
      "label": "email",
      "validators": [
        {
          "validate": "required"
        }
      ]
    }
  ],
  "settings": {
    "type": "object",
    "properties": {
      "importIdentifier": {
        "type": "string"
      },
      "title": {
        "type": "string"
      },
      "allowInvalidSubmit": {
        "type": "boolean"
      },
      "invalidDataBehavior": {
        "type": "string",
        "enum": [
          "BLOCK_SUBMIT",
          "INCLUDE_INVALID_ROWS",
          "REMOVE_INVALID_ROWS",
          "INCLUDE_INVALID_ROWS_AND_VALUES"
        ]
      },
      "backendSync": {
        "type": "boolean"
      },
      "backendSyncMode": {
        "type": "string",
        "enum": [
          "DISABLED",
          "FULL_DATA",
          "MAPPINGS_ONLY"
        ]
      },
      "manualInputDisabled": {
        "type": "boolean"
      },
      "manualInputOnly": {
        "type": "boolean"
      },
      "allowCustomFields": {
        "type": "boolean"
      },
      "passThroughUnmappedColumns": {
        "type": "boolean"
      },
      "maxRecords": {
        "oneOf": [
          {
            "type": "integer"
          },
          {
            "type": "null"
          }
        ]
      },
      "developmentMode": {
        "type": "boolean"
      },
      "displayEncoding": {
        "type": "boolean"
      },
      "styleOverrides": {
        "type": "object"
      },
      "maxFileSize": {
        "type": "integer"
      },
      "webhookUrl": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ]
      },
      "needsReviewWebhookUrl": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ]
      },
      "initialData": {
        "oneOf": [
          {
            "type": "array"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "additionalProperties": false
  },
  "hooks": {
    "type": "object",
    "properties": {
      "rowHooks": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "bulkRowHooks": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "rowDeleteHooks": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "beforeFinishCallback": {
        "type": "string"
      },
      "columnHooks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "fieldName": {
              "type": "string"
            },
            "callback": {
              "type": "string"
            }
          },
          "required": [
            "fieldName",
            "callback"
          ],
          "additionalProperties": false
        }
      },
      "stepHooks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "UPLOAD_STEP",
                "REVIEW_STEP",
                "REVIEW_STEP_POST_HOOKS"
              ]
            },
            "callback": {
              "type": "string"
            }
          },
          "required": [
            "type",
            "callback"
          ],
          "additionalProperties": false
        }
      }
    },
    "additionalProperties": false
  }
}'
{
  "id": "0631f213-ca91-41e0-9a88-7430c7d0ca28",
  "name": "last - email",
  "fields": [
    {
      "key": "lastName",
      "type": "string",
      "label": "last",
      "validators": [
        {
          "validate": "required"
        }
      ]
    },
    {
      "key": "email",
      "type": "email",
      "label": "email",
      "validators": [
        {
          "validate": "required"
        }
      ]
    }
  ],
  "settings": {
    "type": "object",
    "properties": {
      "importIdentifier": {
        "type": "string"
      },
      "title": {
        "type": "string"
      },
      "allowInvalidSubmit": {
        "type": "boolean"
      },
      "invalidDataBehavior": {
        "type": "string",
        "enum": [
          "BLOCK_SUBMIT",
          "INCLUDE_INVALID_ROWS",
          "REMOVE_INVALID_ROWS",
          "INCLUDE_INVALID_ROWS_AND_VALUES"
        ]
      },
      "backendSync": {
        "type": "boolean"
      },
      "backendSyncMode": {
        "type": "string",
        "enum": [
          "DISABLED",
          "FULL_DATA",
          "MAPPINGS_ONLY"
        ]
      },
      "manualInputDisabled": {
        "type": "boolean"
      },
      "manualInputOnly": {
        "type": "boolean"
      },
      "allowCustomFields": {
        "type": "boolean"
      },
      "passThroughUnmappedColumns": {
        "type": "boolean"
      },
      "maxRecords": {
        "oneOf": [
          {
            "type": "integer"
          },
          {
            "type": "null"
          }
        ]
      },
      "developmentMode": {
        "type": "boolean"
      },
      "displayEncoding": {
        "type": "boolean"
      },
      "styleOverrides": {
        "type": "object"
      },
      "maxFileSize": {
        "type": "integer"
      },
      "webhookUrl": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ]
      },
      "needsReviewWebhookUrl": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ]
      },
      "initialData": {
        "oneOf": [
          {
            "type": "array"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "additionalProperties": false
  },
  "hooks": {
    "type": "object",
    "properties": {
      "rowHooks": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "bulkRowHooks": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "rowDeleteHooks": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "beforeFinishCallback": {
        "type": "string"
      },
      "columnHooks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "fieldName": {
              "type": "string"
            },
            "callback": {
              "type": "string"
            }
          },
          "required": [
            "fieldName",
            "callback"
          ],
          "additionalProperties": false
        }
      },
      "stepHooks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "UPLOAD_STEP",
                "REVIEW_STEP",
                "REVIEW_STEP_POST_HOOKS"
              ]
            },
            "callback": {
              "type": "string"
            }
          },
          "required": [
            "type",
            "callback"
          ],
          "additionalProperties": false
        }
      }
    },
    "additionalProperties": false
  }
}

Authorizations

​
X-Dromo-License-Key
string
header
required

This backend API key is different than your frontend license key. Please use the "Backend" license key from your Dromo Dashboard.

Body

application/json

Response

201 - application/json

Schema Created

The response is of type object.