Sign in

v25

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0131545750.2 KB

Import objects

Import multiple objects in batch. Properties are keyed by slug. Automatically routes based on size: small batches complete synchronously and return 200 with the final ImportJob; large batches start an async job, return 202 with status: processing and a Location header, and can be polled via GET /v2/prism/{teamId}/imports/{jobId}.

post/v2/prism/{teamId}/{objectType}/import

Path parameters

teamIdstring uuid required
objectType'comment' | 'identity' | 'organization' | 'contact' | 'action' | 'document' | 'engagement' | 'deal' required

Headers

Idempotency-Keystring

A unique key (UUID or any opaque string up to 255 chars) that identifies this logical request. The server caches the first response under this key for 24 hours and replays it on retry — safe to use on every POST/PUT/PATCH to make network retries deterministic. Reusing the same key with a different body returns 409 idempotency_key_mismatch. Replays include the idempotent-replay: true response header.

Request body

Response

Import complete (sync path for small batches). status is complete, job_id is null, and per-row outcomes are inlined under results.

job_idstring nullable required

Null for sync imports (results inlined). Set for async imports.

status'complete' | 'processing' | 'failed' required
totalinteger required

Total number of rows in the import.

processedinteger

Rows that have been attempted (succeeded + failed).

succeededinteger
failedinteger
created_atstring date-time
updated_atstring date-time
expires_atstring date-time