Template Email

Template email memungkinkan pengembang mengirim email dengan konten serupa ke pelanggan yang berbeda.

Anda dapat melakukan query, menambah, menghapus, dan mengubah template melalui API.

Alamat Endpoint

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

Pastikan pusat data yang dipilih sesuai dengan base URL yang digunakan.

POST/v1/templates

Query (Batch)

Mengembalikan informasi dasar template email.

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header

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 template email
template_invoke_name	string	tidak	nama pemanggil template email

Contoh Request

curl -X GET -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
template_id	ID template
name	nama template
template_invoke_name	nama pemanggil template
html	konten html
preview_text	teks pratinjau template
subject	subjek template
create_time	waktu pembuatan template
update_time	waktu modifikasi template

Contoh Nilai Balik

Response-berhasil

HTTP Status: 200

{ "result": [{ "template_id": 82522, "name": "dffddf", "template_invoke_name": "dffdfd", "html": null, "text": null, "subject": "fdfdfd😅🙂🙂🙂🙂", "preview_text": "", "create_time": "2022-11-10 15:47:05", "update_time": "2022-11-10 15:47:05" }], "count": 10, "total": 20 }

              
              {
    "result": [{
        "template_id": 82522,
        "name": "dffddf",
        "template_invoke_name": "dffdfd",
        "html": null,
        "text": null,
        "subject": "fdfdfd😅🙂🙂🙂🙂",
        "preview_text": "",
        "create_time": "2022-11-10 15:47:05",
        "update_time": "2022-11-10 15:47:05"
    }],
    "count": 10,
    "total": 20
}

Tampilkan blok kode ini di jendela mengambang

Response-gagal

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

Tampilkan blok kode ini di jendela mengambang

Query

Mengembalikan detail informasi template email.

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header

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

Contoh Request

curl -X GET -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/templates/11111111'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
template_id	ID template
name	nama template
template_invoke_name	nama pemanggil template
html	konten template
preview_text	teks pratinjau konten email
subject	subjek konten email
create_time	waktu pembuatan template
update_time	waktu modifikasi template

Contoh Nilai Balik

Response-berhasil

HTTP Status: 200

{ "result": { "template_id": 76707, "name": "libo01s", "template_invoke_name": "libo01d", "html": "The is first email", "text": null, "subject": "happyaaa", "preview_text": "", "create_time": "2019-07-22T11:52:45+0800", "update_time": "2019-08-01T11:29:19+0800" } }

              
              {
    "result": {
        "template_id": 76707,
        "name": "libo01s",
        "template_invoke_name": "libo01d",
        "html": "The is first email",
        "text": null,
        "subject": "happyaaa",
        "preview_text": "",
        "create_time": "2019-07-22T11:52:45+0800",
        "update_time": "2019-08-01T11:29:19+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Response-gagal

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

Tampilkan blok kode ini di jendela mengambang

Tambah

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: 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 Request

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

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
name	string	ya	nama template, maksimal 32 karakter
template_invoke_name	string	ya	nama pemanggil template, 4~64 karakter
html	string	ya	konten html
text	string	tidak	konten teks
subject	string	ya	subjek template, maksimal 255 karakter, bisa emoji
preview_text	string	tidak	pratinjau template, maksimal 255 karakter

Tips:

Variabel diperbolehkan dalam konten html.

Ukuran total pesan email saat pengiriman tidak boleh melebihi 70MB.

Contoh Request

curl -X POST -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}' \ 'https://email.api.engagelab.cc/v1/templates'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}' \
     'https://email.api.engagelab.cc/v1/templates'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
template_id	ID template
name	nama template
template_invoke_name	nama pemanggil template
html	konten template
text	teks template
subject	subjek template
create_time	waktu pembuatan template
update_time	waktu modifikasi template

Contoh Nilai Balik

Response-berhasil

HTTP Status: 200

{ "result": { "template_id": 82525, "name": "zhongg", "template_invoke_name": "gjtest122", "html": "This first template for apiv3", "subject": "xxxxxxx", "preview_text": "", "create_time": "2022-11-14T15:31:17+0800", "update_time": "" } }

              
              {
    "result": {
        "template_id": 82525,
        "name": "zhongg",
        "template_invoke_name": "gjtest122",
        "html": "This first template for apiv3",
        "subject": "xxxxxxx",
        "preview_text": "",
        "create_time": "2022-11-14T15:31:17+0800",
        "update_time": ""
    }
}

Tampilkan blok kode ini di jendela mengambang

Response-gagal

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Header Request

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

Contoh Request

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/templates/11111111'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah template yang dihapus

Contoh Nilai Balik

Response-berhasil

HTTP Status: 200

{ "count": 1 }

              
              { "count": 1 }

Tampilkan blok kode ini di jendela mengambang

Response-gagal

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }

              
              {
    "code": 30000,
    "message": "Authentication failed."
}

Tampilkan blok kode ini di jendela mengambang

Modifikasi

Nama, konten, subjek, dan tipe template dapat dimodifikasi.

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_id}

Tampilkan blok kode ini di jendela mengambang

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: 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 Request

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

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
name	string	tidak	nama template, maksimal 32 karakter
template_invoke_name	string	tidak	nama pemanggil template, 4~64 karakter
html	string	tidak	konten html
text	string	tidak	konten teks
subject	string	tidak	subjek template, maksimal 255 karakter, bisa emoji
preview_text	string	tidak	pratinjau template, maksimal 255 karakter

Tips:

Variabel diperbolehkan dalam konten html.

Ukuran total pesan saat pengiriman tidak boleh melebihi 70MB.

Contoh Request

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"template_invoke_name": "myCustomTemplate"}' \ 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"template_invoke_name": "myCustomTemplate"}' \
     'https://email.api.engagelab.cc/v1/templates/11111111'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah template yang dimodifikasi

Contoh Nilai Balik

Response-berhasil

HTTP Status: 200

{ "count": 1 }

              
              { "count": 1 }

Tampilkan blok kode ini di jendela mengambang

Response-gagal

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }

              
              {
    "code": 30000,
    "message": "Authentication failed."
}

Tampilkan blok kode ini di jendela mengambang