Create a custom object record

POST/api/objects/records

Creates a new record inside the selected custom object definition.

Request Body

application/json

Request payload for Create a custom object record.

TypeScript Definitions

Use the request body type in TypeScript.

objectId*string

Object definition identifier that owns the record.

Example"objdef_123"

data*

Dynamic JSON object keyed by field handle.

Example

{  "name": "Acme",  "stage": "lead"}

Response Body

`application/json`

curl -X POST "https://example.com/api/objects/records" \  -H "Content-Type: application/json" \  -d '{    "objectId": "objdef_123",    "data": {      "name": "Acme",      "stage": "lead"    }  }'

{  "id": "objrec_123"}

{  "_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."}

Create a custom object record

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`