Update a custom data record

PATCH

https://core.shopimind.com/v1/custom-data-records/{id_definition}/{id}

Partially updates a single record. The body is a JSON object whose keys must match fields[].name on the definition; fields not present in the body are left unchanged. Relation fields accept the same direct-id and resolver-object forms as saveCustomDataRecords. Processing is asynchronous.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

"^[a-zA-Z0-9-]{20,64}$"

Path Parameters

id*

The auto-incremented ID of the record to update.

Type

string

Required

id_definition*

The ID of the custom data definition.

Type

string

Required

Request Body

application/json

{

  

"rating": 5

}

Responses

Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items.

Content-Type

application/json

{

  

"statusCode": 200,

  

"sent_count": 5,

  

"rejected_count": 0,

  

"rejected_items": [

  

]

}

PATCH

https://core.shopimind.com/v1/custom-data-records/{id_definition}/{id}

Playground

Headers

spm-api-key*

Variables

Key

Value

id*

id_definition*

Body

Samples

Update a custom data record Partially updates a single record. The body is a JSON object whose keys must match fields[].name on the definition; fields not present in the body are left unchanged. Relation fields accept the same direct-id and resolver-object forms as saveCustomDataRecords. Processing is asynchronous. PATCH /v1/custom-data-records/{id_definition}/{id} updateCustomDataRecord Custom data records spm-api-key [Authentication] Required API key. id The auto-incremented ID of the record to update. id_definition The ID of the custom data definition. Partial fields to update on the record. Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items. All objects are invalid, or the request body is not an array, or the array exceeds the maximum allowed size Server error - Internal processing failure