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}/event/import

Path parameters

teamIdstring uuid required

Headers

Idempotency-Keystring

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.

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

Changes

Changed in 6 of the 29 revisions of this API.11142

    • added the new optional request property options/crm_id

      new-optional-request-property

    • added the new optional request property options/require_list_stage

      new-optional-request-property

    • added the new optional request property options/update_existing

      new-optional-request-property

    • request property options/dedupe_by list-of-types was widened by adding types array to media type application/json

      request-property-list-of-types-widened

    • added the optional property results/items/input_index to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/input_index to the response with the 202 status

      response-optional-property-added

    • added the optional property results/items/updated to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/updated to the response with the 202 status

      response-optional-property-added

    • added the new optional request property options/create_missing_options

      new-optional-request-property

  • fdc16d4f0be01729See the full diff
    • the results/items/error response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • removed the optional property jobId from the response with the 202 status

      response-optional-property-removed

    • removed the optional property message from the response with the 202 status

      response-optional-property-removed

    • removed the optional property summary from the response with the 200 status

      response-optional-property-removed

    • added the new complete enum value to the status response property for the response status 202

      response-property-enum-value-added

    • added the new failed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new failed enum value to the status response property for the response status 202

      response-property-enum-value-added

    • added the new processing enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • added the media type application/json for the response with the status 400

      response-media-type-added

    • added the media type application/json for the response with the status 401

      response-media-type-added

    • added the media type application/json for the response with the status 403

      response-media-type-added

    • added the media type application/json for the response with the status 500

      response-media-type-added

    • added the non-success response with the status 409

      response-non-success-status-added

    • added the optional property created_at to the response with the 200 status

      response-optional-property-added

    • added the optional property created_at to the response with the 202 status

      response-optional-property-added

    • added the optional property error to the response with the 200 status

      response-optional-property-added

    • added the optional property error to the response with the 202 status

      response-optional-property-added

    • added the optional property expires_at to the response with the 200 status

      response-optional-property-added

    • added the optional property expires_at to the response with the 202 status

      response-optional-property-added

    • added the optional property failed to the response with the 200 status

      response-optional-property-added

    • added the optional property failed to the response with the 202 status

      response-optional-property-added

    • added the optional property processed to the response with the 200 status

      response-optional-property-added

    • added the optional property processed to the response with the 202 status

      response-optional-property-added

    • added the optional property results to the response with the 202 status

      response-optional-property-added

    • added the optional property results/items/error/code to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/error/message to the response with the 200 status

      response-optional-property-added

    • added the optional property succeeded to the response with the 200 status

      response-optional-property-added

    • added the optional property succeeded to the response with the 202 status

      response-optional-property-added

    • added the optional property updated_at to the response with the 200 status

      response-optional-property-added

    • added the optional property updated_at to the response with the 202 status

      response-optional-property-added

    • the response property status became required for the status 200

      response-property-became-required

    • the response property status became required for the status 202

      response-property-became-required

    • the response property total became required for the status 202

      response-property-became-required

    • added the required property job_id to the response with the 200 status

      response-required-property-added

    • added the required property job_id to the response with the 202 status

      response-required-property-added

    • added the required property total to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d26f2e12b39f42See the full diff
    • removed the request property objects/items/crm

      request-property-removed

    • removed the request property objects/items/extended

      request-property-removed

    • removed the request property objects/items/id

      request-property-removed

    • removed the request property options/crm_id

      request-property-removed

    • added the new optional request property objects/items/list

      new-optional-request-property

    • added the new optional request property options/list_id

      new-optional-request-property

    • api operation id importEventsV2 removed and replaced with importEvents

      api-operation-id-removed

    • endpoint added

      endpoint-added