API_USER

API_USER is the verification account used to send emails in SendCloud.

You can search or add API_USER with API.

---

Query (Batch Query)

Learn basic information of API_USER through this interface

URL

https://api.sendcloud.net/apiv2/apiuser/list

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
emailType	int	no	email type: 0 (transactional), 1 (marketing)
cType	int	no	API_USER type: 0 (test), 1 (general)
domainName	string	no	bound domain name

Request Example

https://api.sendcloud.net/apiv2/apiuser/list?apiUser=***&apiKey=***&emailType=1&domainName=mail.liubida.cn 

Returned Value Description

parameter	description
name	API_USER name
cType	API_USER type
emailType	API_USER email type
domainName	API_USER bound domain
neteaseSender	API_USER bound NetEase Sender
click	whether to enable click-tracking: 0 (disable), 1 (enable)
open	whether to enable open-tracking: 0 (disable), 1 (enable)
unsubscribe	whether to enable unsubscribe-tracking: 0 (disable), 1 (enable)

Returned Value Example

{
    statusCode: 200,
    info: {
        count: 1,
        dataList: [{
            name: "***",
            cType: "非测试",
            emailType: "触发",
            domainName: "delong.com",
            neteaseSender: "",
            click: 1,
            open: 1,
            unsubscribe: 1
        }]
    },
    message: "请求成功",
    result: true
}

---

Add

Add API_USER with the interface

URL

https://api.sendcloud.net/apiv2/apiuser/add

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
name	string	yes	API_USER name
emailType	int	yes	email type: 0 (transactional), 1 (marketing)
domainName	string	yes	API_USER bound domain name
open	int	no	whether to enable open-tracking: 0 (disable), 1 (enable); enabled by default
click	int	no	whether to enable click-tracking: 0 (disable), 1 (enable)
unsubscribe	int	no	whether to enable unsubscribe-tracking: 0 (disable), 1 (enable); enabled by default

Description

1.To enable click-tracking, you need to make sure the bound domain has passed “cname” configuration validation
2.Unsubscribe-tracking is forced to enable for free registered users
Request Example

Request Example

https://api.sendcloud.net/apiv2/apiuser/add?apiUser=***&apiKey=***&name=liubida&emailType=1&domainName=mail.liubida.cn 

Returned Value Description

parameter	description
name	API_USER name
nameKey	API_KEY name
cType	API_USER type
emailType	API_USER email type
domainName	API_USER bound domain
neteaseSender	API_USER bound NetEase Sender
click	whether to enable click-tracking
open	whether to enable open-tracking
unsubscribe	whether to enable unsubscribe-tracking

Returned Value Example

{
    statusCode: 200,
    info: {
        total: 1,
        data: {
            name: "***",
            nameKey:"********",
            cType: "非测试",
            emailType: "触发",
            domainName: "delong.com",
            neteaseSender: "",
            click: 1,
            open: 1,
            unsubscribe: 1
        }
    },
    message: "请求成功",
    result: true
}