Mục đích: Add một subscriber (email) vào một danh sách khách hàng list.

URL:   /subscribe

PARAMETERS (POST)

1. api_key api_key của account
2. name Họ và tên của người đăng kí (optional)
3. email email người đăng kí
4. list id của list muốn add vào. id này là một giá trị hash (xem trong danh sách list trên portal)
5. boolean = “true” nếu bạn muốn kết quả trả về (result) dạng text

RESPONSE – Kết quả trả về (Plain text)

Success: true

Error: Some fields are missing.

Error: Invalid email address.

Error: Invalid list ID.

Error: Already subscribed.

Mục đích: Xóa một subscriber (email) khỏi một danh sách khách hàng list (unsubscribe)

URL:   /unsubscribe

PARAMETERS (POST)

1. api_key api_key của account
3. email email người đăng kí
5. list id của list muốn add vào. id này là một giá trị hash (xem trong
6. danh sách list trên portal)
8. boolean = “true” nếu bạn muốn kết quả trả về (result) dạng text

RESPONSE – Kết quả trả về (Plain text)

Success: true

Error: Some fields are missing.

Error: Invalid email address.

Mục đích: kiểm tra trạng thái một subscriber trong một list (ví dụ: đã đăng ký – subscribed, đã hủy đăng ký – unsubscribed, mail lỗi – bounced, mail spam – complained).

URL:   http://portal.sendmail.vn/api/subscribers/subscription-status

PARAMETERS (POST)

1. api_key api_key của account
2. email email người đăng kí
3. list id của list muốn add vào. id này là một giá trị hash (xem trong danh sách list trên portal)

RESPONSE – Kết quả trả về (Plain text)

Success: Subscribed

Success: Unsubscribed

Success: Unconfirmed

Success: Bounced

Success: Soft bounced

Success: Complained

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: Email not passed

Error: List ID not passed

Error: Email does not exist in list

Mục đích: Trả về tổng số subscriber của một list.

URL:   http://portal.sendmail.vn/api/subscribers/active-subscriber-count

PARAMETERS (POST)

1. api_key api_key của account
2. list id của list muốn add vào. id này là một giá trị hash (xem trong danh sách list trên portal)

RESPONSE – Kết quả trả về (Plain text)

Success: You'll get an integer of the active subscriber count

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: List ID not passed

Error: List does not exist

Send one

1. api_key api_key của account
2. from_mail email người gửi (optional) – địa chỉ này phải được đăng kí trước đó với sendmail.vn
3. title tiêu đề email
4. body nội dung email (cần phải được encode url trước khi gửi)
5. email email cần gửi

RESPONSE – Kết quả trả về (Plain text)

Success: true

Error: Invalid input data!

Mục đích: gửi email cho một hoặc nhiều danh sách.

URL:  /send-to-lists

PARAMETERS (POST)

1. api_key api_key của account
2. title tiêu đề email
3. body nội dung email (cần phải được encode url trước khi gửi)
4. email_list danh sách các id của list muốn gửi tin. id này là một giá trị hash (xem trong danh sách list trên portal)

RESPONSE – Kết quả trả về (Plain text)
Success: true
Error: Invalid input data!