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://api2.sendcloud.net/api/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://api2.sendcloud.net/api/apiuser/list?apiUser=***&apiKey=***&emailType=1&domainName=mail.liubida.cn 

Returned Value Description

parameter	description
name	API_USER 名称
cType	API_USER 类型
emailType	API_USER email type
domainName	API_USER bound domain
trackDomainName	The tracking domain name bound to API_USER
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: "non-test",
            emailType: "Trigger",
            domainName: "delong.com",
            click: 1,
            open: 1,
            unsubscribe: 1,
            trackDomainName: "track2.sendcloud.net"
        }]
    },
    message: "request was successful",
    result: true
}

---

Add

Add API_USER with the interface

URL

https://api2.sendcloud.net/api/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
trackDomainName	string	no	API_USER bound track name
unsubscribePageId	int	no	unsubscribe page ID
open	int	no	whether to enable open-tracking: 0 (disable), 1 (enable); disableby default
click	int	no	whether to enable click-tracking: 0 (disable), 1 (enable); disableby default
unsubscribe	int	no	whether to enable unsubscribe-tracking: 0 (disable), 1 (enable); enabled by default

Tips:

1. To enable click-tracking, you need to make sure the bound domain has passed “cname” configuration validation.
2. When trackDomainName is the system default tracking domain name (track2.sendcloud.net), reading tracking and click tracking cannot be enabled.

Request Example

https://api2.sendcloud.net/api/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
trackDomainName	The tracking domain name bound to API_USER
click	whether to enable click-tracking
open	whether to enable open-tracking
unsubscribe	whether to enable unsubscribe-tracking

Returned Value Example

{
    statusCode: 200,
    info: {
        data: {
            name: "***",
            nameKey:"********",
            cType: "non-test",
            emailType: "trigger",
            domainName: "delong.com",
            click: 1,
            open: 1,
            unsubscribe: 1,
            trackDomainName: "track2.sendcloud.net"
        }
    },
    message: "Request successful",
    result: true
}

---

Modify

Modify API_USER with the interface

URL

https://api2.sendcloud.net/api/apiuser/update

HTTP Request Method

post    

Parameter Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
name	string	yes	API_USER name
newName	string	no	new API_USER name
domainName	string	no	API_USER bound domain name
trackDomainName	string	no	API_USER bound track name
unsubscribePageId	int	no	unsubscribe page ID
open	int	no	whether to enable open-tracking: 0 (disable), 1 (enable)
click	int	no	whether to enable click-tracking: 0 (disable), 1 (enable)
unsubscribe	int	no	whether to enable unsubscribe-tracking: 0 (disable), 1 (enable)

Tips:

1. Unsubscribe tracking will be forcibly enabled by the system for free users
2. If the trackDomainName is set to the default tracking domain name (track2.sendcloud.net), it is not possible to enable read and click tracking.

Request Example

curl -d 'apiUser=***&apiKey=***&name=scsd&newName=scsd1' https://api2.sendcloud.net/api/apiuser/update

Returned Value Description

parameter	description
name	API_USER name
cType	API_USER type: 0(test), 1(normal)
emailType	email type: 0 (transactional), 1 (marketing)
domainName	API_USER bound domain name
trackDomainName	API_USER bound track name
click	whether to enable click-tracking
open	whether to enable open-tracking
unsubscribe	whether to enable unsubscribe-tracking

Returned Value Example

{ 
    statusCode: 200,
    info: {        
        data: {
            name: "***",
            cType: 1,
            emailType: 0
            domainName: "delong.com",
            trackDomainName: "track2.sendcloud.net",
            click: 1,
            open: 1,
            unsubscribe: 1
        }
    },
    message: "request was successful",
    result: true
}