Activate a custom data definition

PATCH

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

Sets the definition status to active. Active definitions accept new records via saveCustomDataRecords and bulkDeleteCustomDataRecords; inactive definitions reject those calls. The operation is idempotent — calling on an already active definition succeeds without change.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key, in the form {prefix}.{secret}.

Type

string

Required

Example"a1b2c3d4.xK9pR2mVn6QwErTyUiOpAsDfGhJkLzXcVbNmQwErTyU"

Pattern

"^[a-zA-Z0-9]{8}\\.[A-Za-z0-9_-]+$"

Path Parameters

id_definition*

Unique identifier of the custom data definition to activate.

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}/activate

Playground

Headers

spm-api-key*

Variables

Key

Value

id_definition*

Samples

Activate a custom data definition Sets the definition status to active. Active definitions accept new records via saveCustomDataRecords and bulkDeleteCustomDataRecords; inactive definitions reject those calls. The operation is idempotent — calling on an already active definition succeeds without change. PATCH /v1/custom-data-definitions/{id_definition}/activate activateCustomDataDefinition Custom data definitions spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. id_definition Unique identifier of the custom data definition to activate. Client error - Invalid request or authentication issues Server error - Internal processing failure