Create a list or segment

POST

https://core.shopimind.com/v1/lists

Creates a contact list (type=list) or a segment (type=segment). For segments, the server provisions an associated import configuration using segmentationV2 parameters; the segmentation_config itself is set later via updateList. New lists start with zero contacts.

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_-]+$"

Request Body

application/json

{

  

"name": "VIP Customers",

  

"type": "list"

}

Responses

Resource successfully retrieved.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": {

  

  

"id_shop_list": 12,

  

  

"name": "Subscribers FR",

  

  

"type": "list",

  

  

"total_contacts": 0,

  

  

"total_subscribers": 0,

  

  

"total_unsubscribeds": 0,

  

  

"active": 1

  

}

}

POST

https://core.shopimind.com/v1/lists

Playground

Headers

spm-api-key*

Body

Samples

Create a list or segment Creates a contact list (type=list) or a segment (type=segment). For segments, the server provisions an associated import configuration using segmentationV2 parameters; the segmentation_config itself is set later via updateList. New lists start with zero contacts. POST /v1/lists createList Lists spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. Resource successfully retrieved. Client error - Invalid request or authentication issues Server error - Internal processing failure