v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Import-Export

Import Entities

This endpoint enables the import of entities into the platform. The entities should be provided in a CSV format inside an S3 bucket. This API will return the `job_id`` which can be used to fetch the status of the import process.

post/v1/entity:import

Query parameters

job_idstring

The unique identifier of the import job.

Example:abc123

The ID of the import job. This ID is used to track the progress and fetch the result of the import operation.

Request body

schemastring required

The schema of the entities being imported. This must match the schema of the entities on the platform.

Example request

{
  "S3Reference": {
    "bucket": "my-bucket",
    "key": "imports/my-import.json"
  },
  "schema": "contact"
}

Response

The import operation was initiated successfully. The response includes the URLs for the files containing the successful and failed imported entities.