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}.
Path parameters
Headers
A unique key (UUID or any opaque string up to 255 chars) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 idempotency_key_mismatch; reusing it after expiry returns 409 idempotency_key_stale, so use a new key. 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.
Changes
Changed in 6 of the 29 revisions of this API.11142
- ○
added the new optional request property
options/crm_idnew-optional-request-property
- ○
added the new optional request property
options/require_list_stagenew-optional-request-property
- ○
added the new optional request property
options/update_existingnew-optional-request-property
- ○
request property
options/dedupe_bylist-of-types was widened by adding typesarrayto media typeapplication/jsonrequest-property-list-of-types-widened
- ○
added the optional property
results/items/input_indexto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/input_indexto the response with the202statusresponse-optional-property-added
- ○
added the optional property
results/items/updatedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/updatedto the response with the202statusresponse-optional-property-added
- ○
- ○
added the new optional request property
options/create_missing_optionsnew-optional-request-property
- ○
- ▲
the
results/items/errorresponse's property type/format changed fromstring/toobject/for status200response-property-type-changed
- ●
removed the optional property
jobIdfrom the response with the202statusresponse-optional-property-removed
- ●
removed the optional property
messagefrom the response with the202statusresponse-optional-property-removed
- ●
removed the optional property
summaryfrom the response with the200statusresponse-optional-property-removed
- ●
added the new
completeenum value to thestatusresponse property for the response status202response-property-enum-value-added
- ●
added the new
failedenum value to thestatusresponse property for the response status200response-property-enum-value-added
- ●
added the new
failedenum value to thestatusresponse property for the response status202response-property-enum-value-added
- ●
added the new
processingenum value to thestatusresponse property for the response status200response-property-enum-value-added
- ○
added the new optional
headerrequest parameterIdempotency-Keynew-optional-request-parameter
- ○
added the media type
application/jsonfor the response with the status400response-media-type-added
- ○
added the media type
application/jsonfor the response with the status401response-media-type-added
- ○
added the media type
application/jsonfor the response with the status403response-media-type-added
- ○
added the media type
application/jsonfor the response with the status500response-media-type-added
- ○
added the non-success response with the status
409response-non-success-status-added
- ○
added the optional property
created_atto the response with the200statusresponse-optional-property-added
- ○
added the optional property
created_atto the response with the202statusresponse-optional-property-added
- ○
added the optional property
errorto the response with the200statusresponse-optional-property-added
- ○
added the optional property
errorto the response with the202statusresponse-optional-property-added
- ○
added the optional property
expires_atto the response with the200statusresponse-optional-property-added
- ○
added the optional property
expires_atto the response with the202statusresponse-optional-property-added
- ○
added the optional property
failedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
failedto the response with the202statusresponse-optional-property-added
- ○
added the optional property
processedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
processedto the response with the202statusresponse-optional-property-added
- ○
added the optional property
resultsto the response with the202statusresponse-optional-property-added
- ○
added the optional property
results/items/error/codeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/error/messageto the response with the200statusresponse-optional-property-added
- ○
added the optional property
succeededto the response with the200statusresponse-optional-property-added
- ○
added the optional property
succeededto the response with the202statusresponse-optional-property-added
- ○
added the optional property
updated_atto the response with the200statusresponse-optional-property-added
- ○
added the optional property
updated_atto the response with the202statusresponse-optional-property-added
- ○
the response property
statusbecame required for the status200response-property-became-required
- ○
the response property
statusbecame required for the status202response-property-became-required
- ○
the response property
totalbecame required for the status202response-property-became-required
- ○
added the required property
job_idto the response with the200statusresponse-required-property-added
- ○
added the required property
job_idto the response with the202statusresponse-required-property-added
- ○
added the required property
totalto the response with the200statusresponse-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ●
removed the request property
objects/items/crmrequest-property-removed
- ●
removed the request property
objects/items/extendedrequest-property-removed
- ●
removed the request property
objects/items/idrequest-property-removed
- ●
removed the request property
options/crm_idrequest-property-removed
- ○
added the new optional request property
objects/items/listnew-optional-request-property
- ○
added the new optional request property
options/list_idnew-optional-request-property
- ●
- ○
api operation id
importEventsV2removed and replaced withimportEventsapi-operation-id-removed
- ○
- ○
endpoint added
endpoint-added
- ○