Label Email

Label memberikan cara tambahan untuk mendapatkan statistik email.

Anda dapat melakukan query, menambah, menghapus, dan memodifikasi label melalui API.

Alamat Endpoint

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

Saat menggunakan REST API, pastikan data center yang dipilih sesuai dengan base URL yang benar.

POST/v1/labels

Query (Batch)

Mengembalikan daftar label.

URL

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

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

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
label_name	string	tidak	pencarian kabur

Contoh Permintaan

curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
label_id	ID label
label_name	nama label
create_time	waktu pembuatan label
update_time	waktu modifikasi label

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "total": 28, "count": 28, "result": [ { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } ] }

              
              {
   "total": 28,
   "count": 28,
   "result": [
       {
           "label_id": 598802,
           "label_name": "xjm226",
           "create_time": "2022-11-14T14:27:48+0800",
           "update_time": "2022-11-14T14:27:48+0800"
       }
   ]
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

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

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

Tampilkan blok kode ini di jendela mengambang

Query

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_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(apiUser:apiKey)

Contoh Permintaan

curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
label_id	ID label
label_name	nama label
create_time	waktu pembuatan label
update_time	waktu modifikasi label

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": { "label_id": 598100, "label_name": "xiaoxiao", "create_time": "2022-08-09T13:49:46+0800", "update_time": "2022-11-12T14:12:12+0800" } }

              
              {
    "result": {
        "label_id": 598100,
        "label_name": "xiaoxiao",
        "create_time": "2022-08-09T13:49:46+0800",
        "update_time": "2022-11-12T14:12:12+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

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

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

Tampilkan blok kode ini di jendela mengambang

Tambah

URL

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

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

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
label_name	string	ya	nama label yang akan ditambahkan, maks 64 karakter

Tips: Maksimal pembuatan label adalah 100000

Contoh Permintaan

curl -X POST "https://email.api.engagelab.cc/v1/labels" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \ --header "Content-Type: application/json" \ --data '{ "label_name":"hongkong" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/labels" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
  "label_name":"hongkong"
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
label_id	ID label
label_name	nama label
create_time	waktu pembuatan label
update_time	waktu modifikasi label

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:34+0800", "update_time": "2022-11-14T14:27:34+0800" } }

              
              {
    "result": {
        "label_id": 598802,
        "label_name": "xjm226",
        "create_time": "2022-11-14T14:27:34+0800",
        "update_time": "2022-11-14T14:27:34+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :400

{ "code": 30105, "message": "Nama label harus terdiri dari 1-255 karakter" }

              
              {
    "code": 30105,
    "message": "Nama label harus terdiri dari 1-255 karakter"
}

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_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)

Contoh Permintaan

curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah label yang dihapus

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

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

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

Tampilkan blok kode ini di jendela mengambang

Modifikasi

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_id}

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
label_name	string	ya	nama label baru, maks 64 karakter

Contoh Permintaan

curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \ --header "Content-Type: application/json" \ --data '{ "label_name":"travel" }'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
  "label_name":"travel"
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah label yang dimodifikasi

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

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

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

Tampilkan blok kode ini di jendela mengambang