Complaints API

Last updated:2023-08-10

When users report spam emails, their email addresses will be added to the spam complaint list.

In this list, email addresses will be intercepted by the system, and the delivery status will be classified as "Invalid Email - In SendCloud Blacklist: Bounced (worker: address in complaint list)."

You can query and delete email addresses from the list.

Query

URL

https://email.api.engagelab.cc/v1/complaints
          https://email.api.engagelab.cc/v1/complaints

        
This code block in the floating window

HTTP Request Method

GET
          GET

        
This code block in the floating window

Query Parameter Description

Parameter Type Required or not Description
start_date string * Start date (format: yyyy-MM-dd)
end_date string * End date (format: yyyy-MM-dd)
email string * Email address, e.g, 22@gmail.com
offset int no Start position [0-], defaults to 0
limit int no Amount [0-100], defaults to 100

Request Example:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/complaints?offset=0&limit=90'
          curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/complaints?offset=0&limit=90' 

        
This code block in the floating window

Returned Value Description

Parameter Description
email Complaint email address
reason Complaint reason
complaint_time Timestamp of when the complaint occurred
expire_time Expiration time for complaint interception

Returned Value Example

{ "result": [ { "email": "9978977@qq.com", "reason": "from softbounce", "complaint_time": "2016-02-01T14:53:20+0800", "expire_time": "2017-02-01T14:53:20+0800" } ], "count": 1, "total": 1 }
          {
  "result": [
    {
      "email": "9978977@qq.com",
      "reason": "from softbounce",
      "complaint_time": "2016-02-01T14:53:20+0800",
      "expire_time": "2017-02-01T14:53:20+0800"
    }
  ],
  "count": 1,
  "total": 1
}

        
This code block in the floating window

Delete

URL

https://email.api.engagelab.cc/v1/complaints
          https://email.api.engagelab.cc/v1/complaints

        
This code block in the floating window

HTTP Request Method

DELETE
          DELETE

        
This code block in the floating window

Body Parameter Description

Parameter Type Required or not Description
start_date string * Start date (format: yyyy-MM-dd)
end_date string * End date (format: yyyy-MM-dd)
email string * Email addresse to delete

Request Example

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"email": "x@example.com"}' 'https://email.api.engagelab.cc/v1/complaints' curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"start_date": "2023-04-01 08:00:00", "end_date": "2023-07-01 08:00:00"}' 'https://email.api.engagelab.cc/v1/complaints'
          curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"email": "x@example.com"}'
     'https://email.api.engagelab.cc/v1/complaints' 

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"start_date": "2023-04-01 08:00:00", "end_date": "2023-07-01 08:00:00"}'
     'https://email.api.engagelab.cc/v1/complaints' 

        
This code block in the floating window

Returned Value Description None

Returned Value Example

{ "count": 2 }
          {
  "count": 2
}

        
This code block in the floating window
在文档中心打开
icon
Contact Sales