For more information on using API

GET http://webapi.mymarketing.co.il/api/mailinglist/{id}/members?CustomerStates={CustomerStates}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Get all the information of your Mailinglist members by page, limited to 50 contacts each time.

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Mailinglist id

integer

Required

CustomerStates

Choose the states (status) of the contact you want to get

FromDate

The first date the contacts you want were created

date
ToDate

The last date the contacts you want were created.(Default values is 3 last months)

date
Page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

Limit

Limit the number of items you get in the results.

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

Collection of ContactContainerItem

Name

Description

Type

Additional information

id

Contact field

integer
state

Contact field

is_optined

Contact field

boolean
email

Contact field

string
sms

Contact field

string
first_name

Contact field

string
last_name

Contact field

string
anniversary

Contact field

date
birthday

Contact field

date
city

Contact field

string
fax

Contact field

string
phone1

Contact field

string
phone2

Contact field

string
street

Contact field

string
zip_code

Contact field

string
ext1

Contact field

string
ext2

Contact field

string
ext3

Contact field

string
ext4

Contact field

string
ext5

Contact field

string
ext6

Contact field

string
ext7

Contact field

string
ext8

Contact field

string
ext9

Contact field

string
ext10

Contact field

string
ext11

Contact field

string
ext12

Contact field

string
ext13

Contact field

string
ext14

Contact field

string
ext15

Contact field

string
ext16

Contact field

string
ext17

Contact field

string
ext18

Contact field

string
ext19

Contact field

string
ext20

Contact field

string
ext21

Contact field

string
ext22

Contact field

string
ext23

Contact field

string
ext24

Contact field

string
ext25

Contact field

string
date1

Contact field

date
date2

Contact field

date
date3

Contact field

date
date4

Contact field

date
date5

Contact field

date
num1

Contact field

integer
num2

Contact field

integer
num3

Contact field

integer
num4

Contact field

integer
num5

Contact field

integer
is_do_not_mail

Change the 'do not email' state of contact

boolean
is_deleted

Delete the contact

boolean

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "state": "Unsubscribed",
    "is_optined": true,
    "email": "sample string 2",
    "sms": "sample string 3",
    "first_name": "sample string 4",
    "last_name": "sample string 5",
    "anniversary": "2016-12-24T14:12:12",
    "birthday": "2016-12-24T14:12:12",
    "city": "sample string 6",
    "fax": "sample string 7",
    "phone1": "sample string 8",
    "phone2": "sample string 9",
    "street": "sample string 10",
    "zip_code": "sample string 11",
    "ext1": "sample string 12",
    "ext2": "sample string 13",
    "ext3": "sample string 14",
    "ext4": "sample string 15",
    "ext5": "sample string 16",
    "ext6": "sample string 17",
    "ext7": "sample string 18",
    "ext8": "sample string 19",
    "ext9": "sample string 20",
    "ext10": "sample string 21",
    "ext11": "sample string 22",
    "ext12": "sample string 23",
    "ext13": "sample string 24",
    "ext14": "sample string 25",
    "ext15": "sample string 26",
    "ext16": "sample string 27",
    "ext17": "sample string 28",
    "ext18": "sample string 29",
    "ext19": "sample string 30",
    "ext20": "sample string 31",
    "ext21": "sample string 32",
    "ext22": "sample string 33",
    "ext23": "sample string 34",
    "ext24": "sample string 35",
    "ext25": "sample string 36",
    "date1": "2016-12-24T14:12:12",
    "date2": "2016-12-24T14:12:12",
    "date3": "2016-12-24T14:12:12",
    "date4": "2016-12-24T14:12:12",
    "date5": "2016-12-24T14:12:12",
    "num1": 1,
    "num2": 1,
    "num3": 1,
    "num4": 1,
    "num5": 1,
    "is_do_not_mail": true,
    "is_deleted": true
  },
  {
    "id": 1,
    "state": "Unsubscribed",
    "is_optined": true,
    "email": "sample string 2",
    "sms": "sample string 3",
    "first_name": "sample string 4",
    "last_name": "sample string 5",
    "anniversary": "2016-12-24T14:12:12",
    "birthday": "2016-12-24T14:12:12",
    "city": "sample string 6",
    "fax": "sample string 7",
    "phone1": "sample string 8",
    "phone2": "sample string 9",
    "street": "sample string 10",
    "zip_code": "sample string 11",
    "ext1": "sample string 12",
    "ext2": "sample string 13",
    "ext3": "sample string 14",
    "ext4": "sample string 15",
    "ext5": "sample string 16",
    "ext6": "sample string 17",
    "ext7": "sample string 18",
    "ext8": "sample string 19",
    "ext9": "sample string 20",
    "ext10": "sample string 21",
    "ext11": "sample string 22",
    "ext12": "sample string 23",
    "ext13": "sample string 24",
    "ext14": "sample string 25",
    "ext15": "sample string 26",
    "ext16": "sample string 27",
    "ext17": "sample string 28",
    "ext18": "sample string 29",
    "ext19": "sample string 30",
    "ext20": "sample string 31",
    "ext21": "sample string 32",
    "ext22": "sample string 33",
    "ext23": "sample string 34",
    "ext24": "sample string 35",
    "ext25": "sample string 36",
    "date1": "2016-12-24T14:12:12",
    "date2": "2016-12-24T14:12:12",
    "date3": "2016-12-24T14:12:12",
    "date4": "2016-12-24T14:12:12",
    "date5": "2016-12-24T14:12:12",
    "num1": 1,
    "num2": 1,
    "num3": 1,
    "num4": 1,
    "num5": 1,
    "is_do_not_mail": true,
    "is_deleted": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfContactContainerItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <ContactContainerItem>
    <anniversary>2016-12-24T14:12:12</anniversary>
    <birthday>2016-12-24T14:12:12</birthday>
    <city>sample string 6</city>
    <date1>2016-12-24T14:12:12</date1>
    <date2>2016-12-24T14:12:12</date2>
    <date3>2016-12-24T14:12:12</date3>
    <date4>2016-12-24T14:12:12</date4>
    <date5>2016-12-24T14:12:12</date5>
    <email>sample string 2</email>
    <ext1>sample string 12</ext1>
    <ext10>sample string 21</ext10>
    <ext11>sample string 22</ext11>
    <ext12>sample string 23</ext12>
    <ext13>sample string 24</ext13>
    <ext14>sample string 25</ext14>
    <ext15>sample string 26</ext15>
    <ext16>sample string 27</ext16>
    <ext17>sample string 28</ext17>
    <ext18>sample string 29</ext18>
    <ext19>sample string 30</ext19>
    <ext2>sample string 13</ext2>
    <ext20>sample string 31</ext20>
    <ext21>sample string 32</ext21>
    <ext22>sample string 33</ext22>
    <ext23>sample string 34</ext23>
    <ext24>sample string 35</ext24>
    <ext25>sample string 36</ext25>
    <ext3>sample string 14</ext3>
    <ext4>sample string 15</ext4>
    <ext5>sample string 16</ext5>
    <ext6>sample string 17</ext6>
    <ext7>sample string 18</ext7>
    <ext8>sample string 19</ext8>
    <ext9>sample string 20</ext9>
    <fax>sample string 7</fax>
    <first_name>sample string 4</first_name>
    <is_deleted>true</is_deleted>
    <is_do_not_mail>true</is_do_not_mail>
    <last_name>sample string 5</last_name>
    <num1>1</num1>
    <num2>1</num2>
    <num3>1</num3>
    <num4>1</num4>
    <num5>1</num5>
    <phone1>sample string 8</phone1>
    <phone2>sample string 9</phone2>
    <sms>sample string 3</sms>
    <street>sample string 10</street>
    <zip_code>sample string 11</zip_code>
  </ContactContainerItem>
  <ContactContainerItem>
    <anniversary>2016-12-24T14:12:12</anniversary>
    <birthday>2016-12-24T14:12:12</birthday>
    <city>sample string 6</city>
    <date1>2016-12-24T14:12:12</date1>
    <date2>2016-12-24T14:12:12</date2>
    <date3>2016-12-24T14:12:12</date3>
    <date4>2016-12-24T14:12:12</date4>
    <date5>2016-12-24T14:12:12</date5>
    <email>sample string 2</email>
    <ext1>sample string 12</ext1>
    <ext10>sample string 21</ext10>
    <ext11>sample string 22</ext11>
    <ext12>sample string 23</ext12>
    <ext13>sample string 24</ext13>
    <ext14>sample string 25</ext14>
    <ext15>sample string 26</ext15>
    <ext16>sample string 27</ext16>
    <ext17>sample string 28</ext17>
    <ext18>sample string 29</ext18>
    <ext19>sample string 30</ext19>
    <ext2>sample string 13</ext2>
    <ext20>sample string 31</ext20>
    <ext21>sample string 32</ext21>
    <ext22>sample string 33</ext22>
    <ext23>sample string 34</ext23>
    <ext24>sample string 35</ext24>
    <ext25>sample string 36</ext25>
    <ext3>sample string 14</ext3>
    <ext4>sample string 15</ext4>
    <ext5>sample string 16</ext5>
    <ext6>sample string 17</ext6>
    <ext7>sample string 18</ext7>
    <ext8>sample string 19</ext8>
    <ext9>sample string 20</ext9>
    <fax>sample string 7</fax>
    <first_name>sample string 4</first_name>
    <is_deleted>true</is_deleted>
    <is_do_not_mail>true</is_do_not_mail>
    <last_name>sample string 5</last_name>
    <num1>1</num1>
    <num2>1</num2>
    <num3>1</num3>
    <num4>1</num4>
    <num5>1</num5>
    <phone1>sample string 8</phone1>
    <phone2>sample string 9</phone2>
    <sms>sample string 3</sms>
    <street>sample string 10</street>
    <zip_code>sample string 11</zip_code>
  </ContactContainerItem>
</ArrayOfContactContainerItem>