Anggota

Alamat Endpoint

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

Saat menggunakan REST API, pastikan pusat data yang dipilih sesuai dengan base URL yang tepat.

POST/v1/marketing/lists/members

Tambah atau Perbarui Massal

URL

https://email.api.engagelab.cc/v1/marketing/lists/members

              
              https://email.api.engagelab.cc/v1/marketing/lists/members

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

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

Header Permintaan

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

Parameter Body

Parameter	Tipe	Wajib	Deskripsi
members	array[object]	ya	Daftar anggota, maksimal 1000
email	string	ya	Alamat email
phone	string	tidak	Nomor telepon
name	string	tidak	Nama panggilan
fields	object	tidak	Bidang kontak
tags	string[]	tidak	Daftar nama tag
tag_flag	integer	tidak	Metode update tag: 0 timpa, 1 tambah, 2 lewati (default 1)
update_existing	boolean	ya	Apakah memperbarui properti jika email sudah ada

Catatan:

Jika email anggota sama dengan members.email, maka memperbarui anggota. Jika tidak, berarti menambah anggota baru.
Nilai tag_flag menentukan cara update tag. Lihat tabel contoh pada dokumentasi di atas.

Contoh Permintaan

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ -i https://email.api.engagelab.cc/v1/marketing/lists/members \ --data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
-i https://email.api.engagelab.cc/v1/marketing/lists/members \
--data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Response-Berhasil

HttpStatus: 200

{ "created_count": 2, "created_members": [{ "email": "202205ab233444444444446@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0c" },{ "email": "202205ab3331@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0d" }], "updated_count": 2, "updated_members": [{ "email": "202205ab233444444444447@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1c" },{ "email": "202205ab3332@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1d" }], "error_count": 2, "error_members": [{ "email": "202205ab233444444444446@qq.com", "message": "..." },{ "email": "202205ab3331@qq.com", "message": "..." }] }

              
              {
    "created_count": 2,
    "created_members": [{
            "email": "202205ab233444444444446@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0c"
        },{
            "email": "202205ab3331@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0d"
    }],
    "updated_count": 2,
    "updated_members": [{
            "email": "202205ab233444444444447@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1c"
        },{
            "email": "202205ab3332@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1d"
    }],
    "error_count": 2,
    "error_members": [{
            "email": "202205ab233444444444446@qq.com",
            "message": "..."
        },{
            "email": "202205ab3331@qq.com",
            "message": "..."
    }]
}

Tampilkan blok kode ini di jendela mengambang

Response-Gagal

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

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

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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 DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Response-Berhasil

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Response-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Hapus Massal

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/delete

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/delete

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

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

Header Permintaan

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

Parameter Body

Parameter	Tipe	Wajib	Deskripsi
condition	object	tidak	Kondisi query
relation	string	ya	Relasi kondisi (and atau or)
items	object[]	ya	Kondisi filter, maksimal 10, semua harus relasi yang sama
field_name	string	ya	Nama atribut, jika tag maka value=nama tag
op	string	ya	Operator (==, !=, >, >=, <, <=, exist, contain, does not contain)
value	string	ya	Nilai, jika tag maka value=nama tag, jika field lain lihat kondisi-filter

Contoh Permintaan

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data ' { "condition": { "relation": "or", "items": [ { "field_name": "Email", "op": "contain", "value": "hotmail.com" }, { "field_name": "Phone", "op": "contain", "value": "188" } ] } } '

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data '
{
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "Email",
                "op": "contain",
                "value": "hotmail.com"
            },
            {
                "field_name": "Phone",
                "op": "contain",
                "value": "188"
            }
        ]
    }
}
'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Response-Berhasil

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Response-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Perbarui

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

PUT

PUT

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

Header Permintaan

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

Parameter Body

Parameter	Tipe	Wajib	Deskripsi
phone	string	tidak	Nomor telepon
name	string	tidak	Nama panggilan
fields	object	tidak	Bidang anggota
tags	string[]	tidak	Daftar nama tag

Contoh Permintaan

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i \ https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 \ --data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i \
https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 \
--data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Parameter	Tipe	Deskripsi
member_id	string	ID Anggota
list_id	integer	ID Daftar
user_id	integer	ID Pengguna
email	string	Alamat Email
phone	string	Nomor Telepon
name	string	Nama
create_time	string	Waktu Pembuatan (UTC+8)
update_time	string	Waktu Pembaruan (UTC+8)
unsubscribe_time	string	Waktu Berhenti Langganan (UTC+8)
fields	object	Bidang anggota
tags	string[]	ID Tag
tag_names	string[]	Nama Tag

Contoh Respons

Response-Berhasil

HttpStatus: 200

{ "count": 1 }

              
              {
     "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Response-Gagal

HttpStatus: 200

{ "code": 30036, "message": "resource not found" }

              
              {
    "code": 30036,
    "message": "resource not found"
}

Tampilkan blok kode ini di jendela mengambang

Detail Anggota

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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 -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Parameter	Tipe	Deskripsi
member_id	string	ID Anggota
list_id	integer	ID Daftar
email	string	Alamat Email
phone	string	Nomor Telepon
name	string	Nama
create_time	string	Waktu Pembuatan (UTC+8)
update_time	string	Waktu Pembaruan (UTC+8)
unsubscribe_time	string	Waktu Berhenti Langganan (UTC+8)
fields	object	Properti Kontak
tag_ids	string[]	ID Tag
tag_names	string[]	Nama Tag

Response-Berhasil

HttpStatus: 200

{ "result": { "member_id": "6565c12a3b4e0d83d3f58ea0", "list_id": 95964, "email": "xjmfc@126.com", "phone": null, "name": null, "fields": { "Birthday": "03/30", "Age": "12" }, "tag_ids": [], "tag_names": [], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T16:44:44+0800", "unsubscribe_time": null } }

              
              {
    "result": {
        "member_id": "6565c12a3b4e0d83d3f58ea0",
        "list_id": 95964,
        "email": "xjmfc@126.com",
        "phone": null,
        "name": null,
        "fields": {
            "Birthday": "03/30",
            "Age": "12"
        },
        "tag_ids": [],
        "tag_names": [],
        "create_time": "2023-11-28T18:30:02+0800",
        "update_time": "2023-11-30T16:44:44+0800",
        "unsubscribe_time": null
    }
}

Tampilkan blok kode ini di jendela mengambang

Response-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Daftar Anggota

URL

https://email.api.engagelab.cc/v1/marketing/lists/list_members

              
              https://email.api.engagelab.cc/v1/marketing/lists/list_members

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

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

Header Permintaan

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

Parameter Query

Parameter	Tipe	Wajib	Deskripsi
limit	integer	tidak	Jumlah data diambil, rentang [1-100], default 10
offset	integer	tidak	Posisi awal query, rentang [0-], default 0

Parameter Body

Parameter	Tipe	Wajib	Deskripsi
condition	object	tidak	Kondisi query
relation	string	ya	Relasi kondisi (and atau or)
items	object[]	ya	Kondisi filter, maksimal 10, semua harus relasi yang sama
field_name	string	ya	Nama field, jika tag maka value=nama tag
op	string	ya	Operator (==, !=, >, >=, <, <=, exist, contain, does not contain)
value	string	ya	Nilai, jika tag maka value=nama tag, jika field lain lihat kondisi-filter

Catatan:

Lihat hubungan field_name dan op di kondisi-filter

Contoh Permintaan

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{ "condition": { "relation": "and", "items": [ { "field_name": "Email", "op": "contain", "value": "qq.com" } ] } }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{
    "condition": {
        "relation": "and",
        "items": [
            { 
              "field_name": "Email",
              "op": "contain",
              "value": "qq.com"
            }
        ]
    }
}'

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Parameter	Tipe	Deskripsi
list	array	Daftar Anggota
member_id	string	ID Anggota
list_id	integer	ID Daftar
email	string	Alamat Email
phone	string	Nomor Telepon
name	string	Nama
create_time	string	Waktu Pembuatan (UTC+8)
update_time	string	Waktu Pembaruan (UTC+8)
unsubscribe_time	string	Waktu Berhenti Langganan (UTC+8)
fields	object	Properti Anggota
tag_ids	string[]	ID Tag
tag_names	string[]	Nama Tag
total	integer	Total Data

Contoh Respons

Response-Berhasil

HttpStatus: 200

{ "result": [ { "member_id": "6565c12a3b4e0d83d3f58ea0", "list_id": 95964, "email": "xjmfc@126.com", "phone": null, "name": null, "fields": { "Birthday": "03/30", "Age": "12" }, "tag_ids": [], "tag_names": [], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T17:00:19+0800", "unsubscribe_time": null } ], "total": 3, "count": 1 }

              
              {
    "result": [
        {
            "member_id": "6565c12a3b4e0d83d3f58ea0",
            "list_id": 95964,
            "email": "xjmfc@126.com",
            "phone": null,
            "name": null,
            "fields": {
                "Birthday": "03/30",
                "Age": "12"
            },
            "tag_ids": [],
            "tag_names": [],
            "create_time": "2023-11-28T18:30:02+0800",
            "update_time": "2023-11-30T17:00:19+0800",
            "unsubscribe_time": null
        }
    ],
    "total": 3,
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Response-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang