Import object data

Imports object records for the provided handle, optionally using upsert matching.

POST/api/objects/by-handle/{handle}/import

Imports object records for the provided handle, optionally using upsert matching.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"projects"

Request Body

application/json

Request payload for Import object data.

TypeScript Definitions

Use the request body type in TypeScript.

rows*array<>

Input rows to import.

Example

[  {    "name": "Airport Expansion",    "status": "Qualified"  }]

upsert?|

Whether to update existing records when a match is found.

referenceField?|

Field used to match existing records during upsert.

updateLifecycleStatus?|

Explicitly allows product lifecycleStatus values to be imported.

Response Body

`application/json`

curl -X POST "https://example.com/api/objects/by-handle/projects/import" \  -H "Content-Type: application/json" \  -d '{    "rows": [      {        "name": "Airport Expansion",        "status": "Qualified"      }    ]  }'

{  "processed": 0,  "created": 0,  "updated": 0}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`