Deactivate a custom data definition

PATCH

https://core.shopimind.com/v1/custom-data-definitions/{id_definition}/deactivate

Sets the definition status to inactive. While inactive, write operations on records (saveCustomDataRecords, bulkDeleteCustomDataRecords, updateCustomDataRecord, deleteCustomDataRecord) are rejected. Existing records remain readable. The operation is idempotent.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

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

Path Parameters

id_definition*

Unique identifier of the custom data definition to deactivate.

Type

string

Required

Responses

Client error - Invalid request or authentication issues

Content-Type

application/json

{

  

"statusCode": 400,

  

"message": "Invalid request parameters",

  

"error": "Bad Request"

}

PATCH

https://core.shopimind.com/v1/custom-data-definitions/{id_definition}/deactivate

Playground

Headers

spm-api-key*

Variables

Key

Value

id_definition*

Samples

Deactivate a custom data definition Sets the definition status to inactive. While inactive, write operations on records (saveCustomDataRecords, bulkDeleteCustomDataRecords, updateCustomDataRecord, deleteCustomDataRecord) are rejected. Existing records remain readable. The operation is idempotent. PATCH /v1/custom-data-definitions/{id_definition}/deactivate deactivateCustomDataDefinition Custom data definitions spm-api-key [Authentication] Required API key. id_definition Unique identifier of the custom data definition to deactivate. Client error - Invalid request or authentication issues Server error - Internal processing failure