Update a list or segment

PATCH

https://core.shopimind.com/v1/lists/{id_shop_list}

Partially updates an existing list or segment. Only the fields provided are modified. For lists (type=list), only name is mutable. For segments (type=segment), name, segmentation_config (JSON-serialized rule tree), and keep_updated are mutable. Updating segmentation_config re-evaluates the segment asynchronously; counts may lag.

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_shop_list*

List identifier

Type

number

Required

Request Body

application/json

{

  

"name": "Updated VIP Customers",

  

"segmentation_config": "{"conditions":[]}",

  

"keep_updated": true

}

Responses

Resource successfully retrieved.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": {

  

  

"id_shop_list": 12,

  

  

"name": "Subscribers FR (renamed)",

  

  

"type": "list",

  

  

"total_contacts": 3421,

  

  

"total_subscribers": 3200,

  

  

"total_unsubscribeds": 221,

  

  

"active": 1

  

}

}

PATCH

https://core.shopimind.com/v1/lists/{id_shop_list}

Playground

Headers

spm-api-key*

Variables

Key

Value

id_shop_list*

Body

Samples

Update a list or segment Partially updates an existing list or segment. Only the fields provided are modified. For lists (type=list), only name is mutable. For segments (type=segment), name, segmentation_config (JSON-serialized rule tree), and keep_updated are mutable. Updating segmentation_config re-evaluates the segment asynchronously; counts may lag. PATCH /v1/lists/{id_shop_list} updateList Lists spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. id_shop_list List identifier Resource successfully retrieved. Client error - Invalid request or authentication issues Server error - Internal processing failure