Route

Optional configuration, you need to configure the record through MX first. We can forward reply message to the mailbox you specify or push the message to the specified URL.

---

Query( batch)

URL

https://api2.sendcloud.net/api/route/list

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
domain	string	no	domain name
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/route/list?apiUser=***&apiKey=***&domain=post.sc.com&start=0&limit=10

Returned Value Description

parameter	description
id	route ID
domain	domain name
expression	receiving route
action	URL/Email
apiUserRoute	When the action is set to "email address" this parameter is required.

Returned Value Example:

{
  "info": {
    "dataList": [
      {
        "id": 1,
        "domain": "post.sc.com",
        "expression": "*@post.sc.com",
        "action": "http://requestb.in/13kup3a1"
      },
      {
        "id": 2,
        "domain": "notice.sc.com",
        "expression": "*@notice.sc.com",
        "action": "admin@notice.sc.com",
        "apiUserRoute": "sctest"
      }
    ],
    "total": 2,
    "count": 2
  },
  "statusCode": 200,
  "message": "request was successful",
  "result": true
}

---

Query

URL

https://api2.sendcloud.net/api/route/get

HTTP Request Method

post    get

parameter

parameter	type	required or not	description
apiUser	string	no	API_USER
apiKey	string	no	API_KEY
routeId	int	no	route ID

Request Example

https://api2.sendcloud.net/api/route/get?apiUser=***&apiKey=***&routeId=1

Returned Value Description

parameter	description
id	route ID
domain	domain name
expression	receiving route
action	URL/Email
apiUserRoute	API_USER

Returned Value Example:

{
  "info": {
    "data": {
      "id": 1,
      "domain": "post.sc.com",
      "expression": "*@post.sc.com",
      "action": "admin@post.sc.com",
      "apiUserRoute": "sctest"
    }
  },
  "statusCode": 200,
  "message": "request was successful",
  "result": true
}

---

Add

URL

https://api2.sendcloud.net/api/route/add

HTTP Request Method

post    get

parameter

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
expression	string	yes	receiving route. Format is 'regular expression@domain'; it can also be a specific email address. The domain/email domain must be a verified or usable sending domain.
action	string	yes	URL/Email
apiUserRoute	string	*	When the action is set to "email address" this parameter is required.

Request Example

https://api2.sendcloud.net/api/route/add?apiUser=***&apiKey=***&expression=*@post.sc.com&action=admin@post.sc.com&apiUserRoute=sctest

Returned Value Description

parameter	description
id	route ID
domain	domain
expression	receiving route
action	URL/Email
apiUserRoute	When the action is set to "email address," this parameter is required.

Returned Value Example:

{
  "info": {
    "data": {
      "id": 1,
      "domain": "post.sc.com",
      "expression": "*@post.sc.com",
      "action": "admin@post.sc.com",
      "apiUserRoute": "sctest"
    }
  },
  "statusCode": 200,
  "message": "request was successful",
  "result": true
}

---

Modify

URL

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

HTTP Request Method

post    get

parameter

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
routeId	int	yes	route ID
expression	string	yes	receiving route
action	string	yes	URL/Email
apiUserRoute	string	*	When the action is set to "email address" this parameter is required.

Request Example

https://api2.sendcloud.net/api/route/update?apiUser=***&apiKey=***&routeId=1&expression=*@post.sc.com&action=http://requestb.in/13kup3a1

Returned Value Description

parameter	description
count	count of modified receiving route

Returned Value Example:

{
  "statusCode": 200,
  "info": {
    "count": 1
  },
  "message": "request was successful",
  "result": true
}

---

Delete

URL

https://api2.sendcloud.net/api/route/delete

HTTP Request Method

post    get

parameter

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
routeId	int	yes	route ID

Request Example

https://api2.sendcloud.net/api/route/delete?apiUser=***&apiKey=***&routeId=1

Returned Value Description

parameter	description
count	count of receiving receiving route

Returned Value Example:

{
  "statusCode": 200,
  "info": {
    "count": 1
  },
  "message": "request was successful",
  "result": true
}