Skip to main content
POST
/
import-definitions
Create import definition
curl --request POST \
  --url https://app.azalt.co/api/v1/import-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "inputSchema": [
    {
      "name": "<string>",
      "type": "string",
      "required": false,
      "aliases": [
        "<string>"
      ],
      "role": "site_identifier"
    }
  ],
  "processorCode": "<string>",
  "outputSchema": [
    {
      "key": "<string>",
      "label": "<string>",
      "type": "string",
      "periodUnit": "YEARLY",
      "formId": "<string>",
      "formElementId": "<string>",
      "formElementKey": "<string>"
    }
  ],
  "description": "<string>"
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "inputSchema": [
    {
      "name": "<string>",
      "type": "string",
      "required": false,
      "aliases": [
        "<string>"
      ],
      "role": "site_identifier"
    }
  ],
  "processorCode": "<string>",
  "outputSchema": [
    {
      "key": "<string>",
      "label": "<string>",
      "type": "string",
      "periodUnit": "YEARLY",
      "formId": "<string>",
      "formElementId": "<string>",
      "formElementKey": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Required string length: 1 - 255
inputSchema
object[]
required
Minimum array length: 1
processorCode
string
required
Required string length: 1 - 50000
outputSchema
object[]
required
Minimum array length: 1
description
string
Maximum string length: 2000

Response

Successful response

id
string
required
organizationId
string | null
required
name
string
required
description
string | null
required
inputSchema
object[]
required
Minimum array length: 1
processorCode
string
required
outputSchema
object[]
required
Minimum array length: 1
createdAt
string
required
updatedAt
string
required