SendCloud

# Address List

Address list is typically used when sending marketing emails.

You can query, add, modify and delete address list, as well as list member.

# Query address list (batch query)

URL

https://api2.sendcloud.net/api/addresslist/list
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address list no lists of alias address, separated by semicolons
start int no start position, [0-], defaults to 0
limit int no amount, [0-100],defaults to 100

Request Example

https://api2.sendcloud.net/api/addresslist/list?apiUser=***&apiKey=***&limit=2
1

Returned Value Description

Parameter Description
name name of address list
address list of alias addresses, you can call operations by the alias address; it’s formatted as xxx@maillist.sendcloud.org
memberCount count of addresses in the list
description address list description
gmtCreated time of address list creation
gmtUpdated time of address list modification

Returned Value Example

{
    statusCode: 200,
    info: {
        total: 1,
        count: 1,
        dataList: [{
            gmtCreated: "2015-09-15 20:29:01",
            gmtUpdated: "2015-09-15 20:29:01",
            address: "developers4@sendcloud.com",
            description: "desc",
            listType: 0,
            memberCount: 0,
            name: "211"
        }]
    },
    message: "request was successful",
    result: true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Add address list

URL

https://api2.sendcloud.net/api/addresslist/add
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias addresses, you can call operations by the alias address; it’s formatted as xxx@maillist.sendcloud.org
name string yes list name
desc string no list description

Request Example

https://api2.sendcloud.net/api/addresslist/add?apiUser=***&apiKey=***&address=justfortest@maillist.sendcloud.org&name=testlist&desc=test
1

Returned Value Description

Parameter Description
address alias addresses, you can call operations by the alias address
memberCount count of addresses in the list
name list name
description address list description
gmtCreated time of address list creation
gmtUpdated time of address list modification

Returned Value Example

{
    statusCode: 200,
    info: {
        data: {
            gmtCreated: "2015-09-28 17:59:15",
            gmtUpdated: "2015-09-28 17:59:15",
            address: "developers41@sendcloud.com",
            memberCount: 0,
            description: "41",
            listType: 0,
            name: "developer41"
        }
    },
    message: "request was successful",
    result: true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# Delete address list

URL

https://api2.sendcloud.net/api/addresslist/delete
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias addresses, you can call operations by the alias address; it’s formatted as xxx@maillist.sendcloud.org

Request Example

https://api2.sendcloud.net/api/addresslist/delete?apiUser=***&apiKey=***&address=newtest@maillist.sendcloud.org
1

Returned Value Description

Parameter Description
count count of deleted lists

Returned Value Example

{
    statusCode: 200,
    info: {
        count: 1
    },
    message: "request was successful",
    result: true
}
1
2
3
4
5
6
7
8

# Modify address list

URL

https://api2.sendcloud.net/api/addresslist/update
1

HTTP请求方式

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias addresses, you can call operations by the alias address; it’s formatted as xxx@maillist.sendcloud.org
newAddress string no new alias address
name string no name of modified list
desc string no description of modified list

Tips:

【newAddress】,【name】 or 【description】can be modified individually or in combination
1

Request Example

https://api2.sendcloud.net/api/addresslist/update?apiUser=***&apiKey=***&address=justfortest@maillist.sendcloud.org&name=newtest
1

Returned Value Description

Parameter Description
count count of modified lists

Returned Value Description

{
    statusCode: 200,
    info: {
        count: 1
    },
    message: "request was successful",
    result: true
}
1
2
3
4
5
6
7
8
9

# Query list member (batch query)

URL

https://api2.sendcloud.net/api/addressmember/list
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias address in address list
start int no start position, [0-], defaults to 0
limit int no amount, [0-100],defaults to 100

Request Example

https://api2.sendcloud.net/apiv2/addressmember/list?apiUser=***&apiKey=***&address=newtest@maillist.sendcloud.org
1

Return Value Description

Parameter Description
gmtCreated time of member creation
gmtUpdated time of member modification
address address list of member
member email address of member
name member name
vars variables

Returned Value Example

{
  "statusCode": 200,
  "info": {
    "dataList": [
      {
        "gmtCreated": "2015-04-30 11:15:43",
        "gmtUpdated": "2015-04-30 11:15:43",
        "address": "test@maillist.sendcloud.org",
        "member": "001@160it.com",
        "name": "001",
        "vars": ""
      },
      {
        "gmtCreated": "2015-04-30 11:17:01",
        "gmtUpdated": "2015-04-30 11:17:01",
        "address": "test@maillist.sendcloud.org",
        "member": "01@mail.yedao.cc",
        "name": "002",
        "vars": ""
      },
      {
        "gmtCreated": "2015-04-30 11:16:41",
        "gmtUpdated": "2015-04-30 11:16:41",
        "address": "test@maillist.sendcloud.org",
        "member": "057966@gmail.com",
        "vars": ""
      }
    ],
    "total": 11378,
    "count": 3
  },
  "message": "request was successful",
  "result": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# Query list member

URL

https://api2.sendcloud.net/api/addressmember/get
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias address in address list
members list yes addresses of list members

Request Example

https://api2.sendcloud.net/apiv2/addressmember/get?apiUser=***&apiKey=***&address=newtest@maillist.sendcloud.org&members=ben@ifaxin.com
1

Returned Value Description

parameter Description
gmtCreated time of member creation
gmtUpdated time of member modification
address address list of member
member email address of member
name member name
vars variables

Returned Value Example

{
  "statusCode": 200,
  "message": "request was successful",
  "result": true,
  "info": {
    "dataList": [
      {
        "gmtCreated": "2015-04-30 11:15:43",
        "gmtUpdated": "2015-04-30 11:15:43",
        "address": "***",
        "member": "001@160it.com",
        "name": "001",
        "vars": ""
      }
    ],
    "count": 1
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# Add list member

URL

https://api2.sendcloud.net/api/addressmember/add
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias address in address list
members list yes lists of members addition. multiple addresses separated by semicolons
names list no member names are separated by semicolons
vars list no substitution variables are corresponding to members, and formatted as {“money”:”1000”}; separated by semicolons

Tips:

1.You can add up to 1000 members on each request
2.If “vars” is included, the amount of “vars” should be same as the count of members'.
3.When adding “vars”, do not attach “%” to “key”
4.In “vars”, if “key” is “name”, the variable will be overlaid by “name”
5.Global variable “recipient” can be used when sending address list, and the value is recipient’s email address
1
2
3
4
5

Request Example

https://api2.sendcloud.net/api/addressmember/add?apiUser=***&apiKey=***&address=yourlist@maillist.sendcloud.org&members=1@1.com;2.@2.com&vars={"money":"99"};{"money":"900"}
1

Returned Value Description

Parameter Description
count number of email addresses added successfully
invalidCount number of email addresses that failed to be added
invalidAddressList details of email addresses that failed to be added
reasonList the reason for the failed email address to be added (corresponding to the address details)

Returned Value Example

{
    "result": true,
    "statusCode": 200,
    "message": "Request successful",
    "info": {
        "count": 2,
        "invalidCount": 1,
        "reasonList": [
            "Member address does not meet the email address specification"
        ],
        "invalidAddressList": [
            "wang3.@gmail.com"
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# Modify list member

URL

https://api2.sendcloud.net/api/addressmember/update
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias address in address list
members list yes former addresses of the updated members, separated by semicolons
newMembers list yes updated addresses of the updated members, separated by semicolons; corresponding to the members
names list no names of list members, separated by semicolons
vars list no substitution variables, corresponding to members, are formatted as {“money”:”1000”}; separated by semicolons

Tips:

1. You can modify up to 1000 members on each request
1

Request Example

https://api2.sendcloud.net/api/addressmember/update?apiUser=***&apiKey=***&address=yourlist@maillist.sendcloud.org&members=1@1.com;2@2.com&vars={"money":"199"};{"money":"1900"}
1

Returned Value Description

Parameter Description
count number of email addresses added successfully
addressNotExistCount email address does not exist
invalidCount number of email addresses that failed to be added
invalidAddressList details of email addresses that failed to be added
reasonList the reason for the failed email address to be added (corresponding to the address details)

Returned Value Example

{
    "result": true,
    "statusCode": 200,
    "message": "Request successful",
    "info": {
        "addressNotExistCount": 1,
        "count": 1,
        "invalidCount": 2,
        "reasonList": [
            "Member address does not meet the email address specification",
            "address not found"
        ],
        "invalidAddressList": [
            "wang2.@gmail.com",
            "wang0@gmail.com"
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# Delete list member

URL

https://api2.sendcloud.net/api/addressmember/delete
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
address string yes alias address in address list
members list yes addresses of the members to be deleted, separated by semicolons

Request Example

https://api2.sendcloud.net/api/addressmember/delete?apiUser=***&apiKey=***&address=newtest@maillist.sendcloud.org&members=3@3.com;4@4.com
1

Returned Value Description

Parameter Description
count count of deleted addresses

Returned Value Example

{
    statusCode: 200,
    info: {
        count: 2
    },
    message: "request was successful",
    result: true
}
1
2
3
4
5
6
7
8
Last Updated: 2025/03/25 10:38:59

Email Label

Query address list (batch query)
Add address list
Delete address list
Modify address list
Query list member (batch query)
Query list member
Add list member
Modify list member
Delete list member