Create an import job

Creates an import job in pending_approval status. Call approve to run it.

POST/imports

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Request body

requiredapplication/json

adapterstringrequired

Allowed:pdfdocusignpandadoc

payloadobject

Responses

201

Created

dataImportJobrequired

Show properties

idstringrequired

adapterstringrequired

Allowed:pdfdocusignpandadoc

statusstringrequired

payloadanyrequired

processed_countintegerrequired

total_countinteger | null

cursorstring | null

errorstring | null

approved_bystring | null

approved_atstring<date-time> | null

created_bystringrequired

created_atstring<date-time>required

updated_atstring<date-time>required

400

Invalid request parameters

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST "https://api.seal.nyc/api/v1/imports" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "adapter": "pdf",
  "payload": {}
}'

const response = await fetch("https://api.seal.nyc/api/v1/imports", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"adapter\": \"pdf\",\n  \"payload\": {}\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/imports",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"adapter\": \"pdf\",\n  \"payload\": {}\n}",
)

Response

{
  "data": {
    "id": "string",
    "adapter": "pdf",
    "status": "string",
    "payload": null,
    "processed_count": 0,
    "total_count": 0,
    "cursor": "string",
    "error": "string",
    "approved_by": "string",
    "approved_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "type": "VALIDATION_ERROR",
  "status": 400,
  "title": "Validation failed",
  "details": {
    "email": [
      "Must be a valid email address"
    ]
  }
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}