Daftar Alamat

Daftar alamat biasanya digunakan untuk pengiriman email pemasaran.

Anda dapat melakukan query, menambah, mengubah, dan menghapus daftar alamat serta anggota daftar.

Endpoint Daftar Alamat

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

Pastikan memilih pusat data dan base URL yang sesuai saat menggunakan REST API.

POST /v1/address_lists

Query Daftar Alamat (Batch)

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Deskripsi Parameter Query

Parameter	Tipe	Wajib	Deskripsi
offset	int	tidak	posisi offset, [0-], default 0
limit	int	tidak	jumlah, [0-100], default 100
name	string	tidak	nama daftar alamat
address	string	tidak	alamat alias daftar alamat

Contoh Permintaan

curl 'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='

              
              curl  'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
address_list_id	id daftar
name	nama daftar alamat
address	alamat alias, gunakan untuk operasi, format: xxx@maillist.email.engagelab.com
member_count	jumlah alamat dalam daftar
desc	deskripsi daftar alamat
create_time	waktu pembuatan daftar
update_time	waktu modifikasi daftar

Query Daftar Alamat (Detail)

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Contoh Permintaan

curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
address_list_id	id daftar alamat
name	nama daftar
address	alamat alias, gunakan untuk pemanggilan, format xxx@maillist.email.engagelab.com
member_count	jumlah alamat dalam daftar
desc	deskripsi daftar alamat
create_time	waktu pembuatan daftar
update_time	waktu modifikasi daftar

Tambah Daftar Alamat

URL

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

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

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 Permintaan

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

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
name	string	ya	nama daftar, maksimal 48 karakter
address	string	ya	contoh: marketing@maillist.email.engagelab.com
desc	string	tidak	deskripsi daftar

Contoh Permintaan

curl -X POST "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"scgd@email.engagelab.com", "name":"hongKong", "desc":"" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"scgd@email.engagelab.com",
"name":"hongKong",
"desc":""
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
address_list_id	id daftar
address	alamat daftar
member_count	jumlah anggota dalam daftar
name	nama daftar
desc	deskripsi daftar alamat
create_time	waktu pembuatan daftar
update_time	waktu modifikasi daftar

Hapus Daftar Alamat

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah daftar yang dihapus

Ubah Daftar Alamat

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

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

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
address	string	tidak	contoh: marketing@maillist.email.engagelab.com
name	string	tidak	nama daftar yang diubah
desc	string	tidak	deskripsi daftar yang diubah

Tips:

【name】atau【desc】dapat diubah secara terpisah atau bersamaan.

Query Anggota Daftar

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Deskripsi Parameter Query

Parameter	Tipe	Wajib	Deskripsi
offset	int	tidak	posisi offset, [0-], default 0
limit	int	tidak	jumlah, [0-100], default 100
email	string	tidak	query alamat email anggota, mendukung pencarian fuzzy
member_ids	string	tidak	beberapa ID anggota dipisahkan ';', maksimal 100

Tambah Anggota Daftar

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

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 Permintaan

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

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
members	array[object]	ya	daftar anggota, maksimal 1000 anggota
email	string	ya	alamat email anggota
name	string	tidak	nama anggota, maksimal 128 karakter
vars	string	tidak	variabel, maksimal 1 KB

Tips:

Saat menambah variabel vars, key tidak perlu diawali '%', dan panjang key maksimal 32 karakter.
Dalam vars, key name akan ditimpa oleh parameter name.
Saat mengirim ke daftar alamat, Anda dapat menggunakan variabel global recipient dengan nilai alamat email penerima.

Ubah Anggota Daftar

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}

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

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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 anggota
name	string	tidak	nama anggota, maksimal 128 karakter
vars	object	tidak	variabel, maksimal 1 KB, panjang key maksimal 32 karakter

Hapus Anggota Daftar

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

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

Deskripsi Parameter Query

Parameter	Tipe	Wajib	Deskripsi
member_ids	string	ya	Daftar ID anggota dipisahkan titik koma (';'), maksimal 100 anggota

Catatan:

Semua contoh respons dan error mengikuti format JSON standar.
Jika terjadi error autentikasi, API akan mengembalikan kode 30000 dan pesan "Autentikasi gagal."