API Unsubscribes

Ketika penerima berhenti berlangganan email, alamat mereka akan masuk ke daftar unsubscribe. Email tidak akan lagi dikirim ke alamat yang sudah berhenti berlangganan. Anda dapat mencari, menambah, dan menghapus alamat pada daftar ini.

Alamat Endpoint

Data Center	URL
Singapura	https://email.api.engagelab.cc
Turki	https://emailapi-tr.engagelab.com

Pastikan data center yang dipilih sesuai dengan base URL saat menggunakan REST API.

POST /v1/unsubscribes

Pencarian

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Query

Parameter	Tipe	Wajib	Deskripsi
start_date	string	*	Tanggal mulai (format: yyyy-MM-dd)
end_date	string	*	Tanggal akhir (format: yyyy-MM-dd)
email	string	*	Alamat email, misal `22@gmail.com`
api_user	string	tidak	API_USER tertentu, default `all`
offset	int	tidak	Offset awal [0-], default 0
limit	int	tidak	Jumlah [0-100], default 100

Tips:

Rentang waktu tidak boleh lebih dari 3 bulan.
Jika pencarian berdasarkan alamat email tertentu, rentang waktu akan diabaikan.

Contoh Permintaan:

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

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
email	Alamat email
api_user	API_USER
type	Jenis berhenti langganan (0, 1, 2, 3)
unsubscribe_time	Waktu berhenti berlangganan
expire_time	Waktu kedaluwarsa blokir unsubscribe

Tipe	Deskripsi
0	Saya tidak ingin menerima email seperti ini lagi
1	Saya tidak pernah berlangganan
2	Ini adalah email spam
3	Ini adalah email penipuan, saya ingin melaporkannya

Contoh Nilai Balik:

{ "result": [ { "email": "524244185@qq.com", "unsubscribe_time": "2021-01-12T17:03:23+08:00", "expire_time": "2023-01-12T17:03:23+08:00", "api_user": "delong_test", "type": 0 } ], "count": 1, "total": 1 }

              
              {
  "result": [
    {
      "email": "524244185@qq.com",
      "unsubscribe_time": "2021-01-12T17:03:23+08:00",
      "expire_time": "2023-01-12T17:03:23+08:00",
      "api_user": "delong_test",
      "type": 0
    }
  ],
  "count": 1,
  "total": 1
}

Tampilkan blok kode ini di jendela mengambang

Tambah

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json;charset=utf-8

              
              application/json;charset=utf-8

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
email	string	ya	Alamat email yang akan ditambahkan
expire_time	string	ya	Waktu kedaluwarsa blokir unsubscribe (format: yyyy-MM-dd)

Contoh Permintaan:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}' \ 'https://email.api.engagelab.cc/v1/unsubscribes'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}' \
     'https://email.api.engagelab.cc/v1/unsubscribes'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
email	Alamat email
api_user	API_USER
unsubscribe_time	Waktu berhenti langganan
expire_time	Waktu kedaluwarsa

Contoh Nilai Balik:

{ "result": { "email": "abc@qq.com", "api_user": "api_user", "unsubscribe_time": "2014-11-19 10:57:24", "expire_time": "2014-11-19 10:57:24" } }

              
              {
    "result": {
        "email": "abc@qq.com",
        "api_user": "api_user",
        "unsubscribe_time": "2014-11-19 10:57:24",
        "expire_time": "2014-11-19 10:57:24"
    }
}

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
email	string	*	Alamat email yang akan dihapus
start_date	string	*	Tanggal mulai (format: yyyy-MM-dd)
end_date	string	*	Tanggal akhir (format: yyyy-MM-dd)

Contoh Permintaan

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

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	Jumlah alamat email yang dihapus

Contoh Nilai Balik:

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respon error

{ "code": 30000, "message": "Autentikasi gagal." }

              
              {
    "code": 30000,
    "message": "Autentikasi gagal."
}

Tampilkan blok kode ini di jendela mengambang