Manajemen Tag

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 benar.

POST/v1/marketing/lists/tags

Membuat Tag

URL

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

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

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
tag_name	string	ya	Nama tag, maksimal 64 karakter, hanya a-z, A-Z, 0-9, _, karakter Tionghoa, dll.

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/tags --data '{ "name": "myCustomTag" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{
  "name": "myCustomTag"
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus:200

{ "result":{ "tag_id": "62732d3ddd017d22ccd118e4", "tag_name": "education", "create_time": "2023-11-28T11:14:48+0800", "update_time": "2023-11-28T11:14:48+0800" } }

              
              {
    "result":{
      "tag_id": "62732d3ddd017d22ccd118e4",
      "tag_name": "education",
      "create_time": "2023-11-28T11:14:48+0800",
      "update_time": "2023-11-28T11:14:48+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Hapus Tag

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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/tags/61c2be010d2b4e6a3836ab1f

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

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "count": 1 }

              
              {
   "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

{ "code": 30036, "message": "resource tidak ditemukan" }

              
              {
    "code": 30036,
    "message": "resource tidak ditemukan"
}

Tampilkan blok kode ini di jendela mengambang

Perbarui Tag

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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
tag_name	string	tidak	Nama tag, maksimal 64 karakter, hanya a-z, A-Z, 0-9, _, karakter Tionghoa, dll.

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/tags/617a71ac672b2823a1a82c13 --data '{ "name": "myCustomTag" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/617a71ac672b2823a1a82c13 --data '{
  "name": "myCustomTag"
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "count": 1 }

              
              {
   "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 400

{ "code": 30035, "message": "Nama tag hanya terdiri dari a-z, A-Z, 0-9, _, karakter Tionghoa, maksimal 64 karakter" }

              
              {
    "code": 30035,
    "message": "Nama tag hanya terdiri dari a-z, A-Z, 0-9, _, karakter Tionghoa, maksimal 64 karakter"
}

Tampilkan blok kode ini di jendela mengambang

Daftar Tag

URL

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

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

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)

Parameter Query

Parameter	Tipe	Wajib	Deskripsi
tag_name	string	tidak	Nama tag untuk pencarian (mendukung pencarian kabur)
offset	integer	tidak	Posisi awal pencarian, rentang [0-], default 0
limit	integer	tidak	Jumlah data, rentang [1-100], default 10

Contoh Permintaan

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Parameter	Tipe	Deskripsi
result	array[object]	Daftar Tag
tag_id	string	ID Tag
tag_name	string	Nama Tag
create_time	string	Waktu Pembuatan
update_time	string	Waktu Pembaruan
count	integer	Jumlah anggota dengan Tag
total	integer	Total Data

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "result": [ { "tag_id": "617a71ac672b2823a1a82c13", "tag_name": "education", "create_time": "2023-11-28T11:14:48+0800", "update_time":"2023-11-28T11:14:48+0800", "count": 1 } ], "count": 1, "total": 1 }

              
              {
  "result": [
    {
      "tag_id": "617a71ac672b2823a1a82c13",
      "tag_name": "education",
      "create_time": "2023-11-28T11:14:48+0800",
      "update_time":"2023-11-28T11:14:48+0800",
      "count": 1
    }
  ],
  "count": 1,
  "total": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Tambah Tag ke Anggota

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add

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
member_ids	string[]	ya	Daftar ID anggota, maksimal 1000 ID anggota per kali

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/tags/61c2be010d2b4e6a3836ab1f/add --data '{
  "member_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus: 200

{ "count": 2 }

              
              {
 "count": 2
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Hapus Tag dari Anggota

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove

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
member_ids	array[string]	ya	Daftar ID anggota, maksimal 1000 ID anggota per kali

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/tags/616683a13a7b531b0336108d/remove --data '{
  "member_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Respons

Respons-Berhasil

HttpStatus:200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Dapatkan Anggota Berdasarkan Tag

URL

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

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

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)

Parameter Query

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

Contoh Permintaan

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Parameter	Tipe	Deskripsi
result	object	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	Field Anggota
tag_ids	array[string]	Kumpulan ID Tag
tag_names	array[string]	Kumpulan Nama Tag
total	integer	Total Data yang Sesuai

Contoh Respons

Respons-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": [ "646f28a7cac6587565ad6918" ], "tag_names": [ "test" ], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T16:42:11+0800", "unsubscribe_time": null } ], "total": 2, "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": [
                "646f28a7cac6587565ad6918"
            ],
            "tag_names": [
                "test"
            ],
            "create_time": "2023-11-28T18:30:02+0800",
            "update_time": "2023-11-30T16:42:11+0800",
            "unsubscribe_time": null
        }
    ],
    "total": 2,
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-Gagal

HttpStatus: 401

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

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

Tampilkan blok kode ini di jendela mengambang