Skip to main content
POST
/
integrations
/
v2
/
integrations
/
import
Import Integration
curl --request POST \
  --url https://api-qa.interactly.ai/integrations/v2/integrations/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": {},
  "use_cases": [
    {}
  ],
  "resource_records": [
    {}
  ]
}
'
{
  "integration_id": "<string>",
  "use_cases_created": 123,
  "resource_records_created": 123,
  "errors": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json

Request body for the import endpoint.

Uses plain Pydantic models (not Beanie documents) so the body can be parsed without a live MongoDB connection. The endpoint validates each item against the appropriate BaseConfig TypeAdapter after parsing.

​
integration
IntegrationImportItem · object

Generic schema-less item used in import body parsing — accepts any fields.

​
use_cases
IntegrationImportItem · object[]
​
resource_records
IntegrationImportItem · object[]

Response

Successful Response

Summary returned by the import endpoint.

​
integration_id
string
required

MongoDB id of the newly created integration.

​
use_cases_created
integer
required

Number of use cases successfully imported.

​
resource_records_created
integer
required

Number of resource records successfully imported.

​
errors
string[]

Non-fatal errors from use-case/resource-record creation.