Method :POST

URL: https://apiv1.publicators.com/api/Recipients/GetCustomerListsByListName

Get active lists by name. Rarely its possible that there are more than one list with the same name.

Request Information

URI Parameters

None.

Body Parameters

Json format: CustomerListBindingModel

CustomerListBindingModel
NameDescriptionTypeAdditional information
list_name

List Name Max length: 200 characters long.

string

Required

Auth

Authorization Token

AuthorizationTokenBindingModel

Required

Request Formats

application/json, text/json

Sample:
{
  "list_name": "sample string 1",
  "Auth": {
    "Token": "32caa95a-a449-4c4a-8bee-a8aca7c5eb3d"
  }
}

Response Information

Resource Description

Json format: IEnumerable of CustomerListViewModel

Collection of CustomerListViewModel
NameDescriptionTypeAdditional information
list_id

List Id

integer

None.

list_name

List Name

string

None.

list_created

List Date Created DateTime format yyyy/MM/dd HH:mm:ss

date

None.

list_test

Is this list used for testing campaigns

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "list_id": 1,
    "list_name": "sample string 2",
    "list_created": "2018/10/22 13:18:10",
    "list_test": true
  },
  {
    "list_id": 1,
    "list_name": "sample string 2",
    "list_created": "2018/10/22 13:18:10",
    "list_test": true
  }
]