Member_fields
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/fields
Membuat
URL
https://email.api.engagelab.cc/v1/marketing/lists/fields
https://email.api.engagelab.cc/v1/marketing/lists/fields
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 |
|---|---|---|---|
| field_name | string | ya | Nama field (maksimal 64 karakter, hanya a-z, A-Z, 0-9, _; tidak boleh sama dengan field sistem, termasuk Email, Name, Phone; total maksimal 50 field) |
| field_type | integer | ya | Tipe field (0: teks, 1: angka, 2: tanggal, 3: ulang tahun, 4: dropdown) |
| visible | boolean | ya | Apakah field terlihat, true atau false |
| format | string | tidak | Format data: 0 atau .0 atau .00 (field_type=1); MM/DD/YYYY atau DD/MM/YYYY (field_type=2); MM/DD atau DD/MM (field_type=3) |
| options | string[] | tidak | Daftar item untuk tipe dropdown, wajib diisi jika field_type=4, maksimal 10 item |
Catatan:
- Field sistem: Email, Name, Phone, Tag, Campaign, Segment, Domain, CreateTime, UpdateTime, UnsubscribeTime.
- Nama field tidak boleh sama dengan field sistem, dan perbedaan huruf besar/kecil tidak dianggap berbeda.
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/fields --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
Tampilkan blok kode ini di jendela mengambang
Respon-Berhasil
HttpStatus: 200
{
"result": {
"field_id": 11,
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}
}
{
"result": {
"field_id": 11,
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}
}
Tampilkan blok kode ini di jendela mengambang
Respon-Gagal
HTTP Status :401
{
"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/fields/{field_id}
https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_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/fields/569
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/569
Tampilkan blok kode ini di jendela mengambang
Contoh Respon
Respon-Berhasil
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Tampilkan blok kode ini di jendela mengambang
Respon-Gagal
{
"code": 30037,
"message": "gagal menghapus"
}
{
"code": 30037,
"message": "gagal menghapus"
}
Tampilkan blok kode ini di jendela mengambang
Perbarui
URL
https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}
https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_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 |
|---|---|---|---|
| field_name | string | ya | Nama field (maksimal 64 karakter, hanya a-z, A-Z, 0-9, _, tidak boleh sama dengan field sistem; total 50 field termasuk field sistem Email, Name, Phone) |
| field_type | integer | ya | Tipe field (0: teks, 1: angka, 2: tanggal, 3: ulang tahun, 4: dropdown) |
| visible | boolean | ya | Apakah field terlihat, true atau false |
| format | string | tidak | Format data: 0 atau .0 atau .00 (field_type=1); MM/DD/YYYY atau DD/MM/YYYY (field_type=2); MM/DD atau DD/MM (field_type=3) |
| options | string[] | tidak | Daftar item dropdown untuk tipe dropdown; wajib diisi jika field_type=4, maksimal 10 item |
Catatan:
- Field sistem: Email, Name, Phone, tag, campaign, segment, domain, createTime, updateTime, unsubscribeTime
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/fields/839 --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/839 --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
Tampilkan blok kode ini di jendela mengambang
Contoh Respon
Respon-Berhasil
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Tampilkan blok kode ini di jendela mengambang
Respon-Gagal
{
"code": 30036,
"message": "tidak ditemukan"
}
{
"code": 30036,
"message": "tidak ditemukan"
}
Tampilkan blok kode ini di jendela mengambang
Daftar Field
URL
https://email.api.engagelab.cc/v1/marketing/lists/fields
https://email.api.engagelab.cc/v1/marketing/lists/fields
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 |
|---|---|---|---|
| field_name | string | tidak | Nama field, pencarian fuzzy |
Contoh Permintaan
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age
Tampilkan blok kode ini di jendela mengambang
Parameter Respon
| Parameter | Tipe | Deskripsi |
|---|---|---|
| result | array[object] | Daftar Field |
| field_name | string | Nama field (maksimal 64 karakter, hanya a-z, A-Z, 0-9, _, tidak boleh sama dengan field sistem; total 50 field termasuk field sistem seperti Email, Name, Phone) |
| field_type | integer | Tipe field (0: teks, 1: angka, 2: tanggal, 3: ulang tahun, 4: dropdown) |
| visible | boolean | Visibilitas (true atau false) |
| format | string | Format data: 0 atau .0 atau .00 (field_type=1); MM/DD/YYYY atau DD/MM/YYYY (field_type=2); MM/DD atau DD/MM (field_type=3) |
| options | string[] | Daftar dropdown untuk tipe dropdown, wajib diisi jika field_type=4, maksimal 10 item |
| field_id | integer | Indeks field, -1 untuk field sistem |
| total | integer | Jumlah total data yang cocok dengan pencarian |
| count | integer | Jumlah data yang cocok pada hasil pencarian ini |
Contoh Respon
Respon-Berhasil
HttpStatus: 200
{
"result": [
{
"field_name": "Email",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Name",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Phone",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Gender",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 0
},
{
"field_name": "Birthday",
"field_type": 3,
"visible": true,
"format": "MM/DD",
"options": null,
"field_id": 1
},
{
"field_name": "Age",
"field_type": 1,
"visible": true,
"format": "0",
"options": null,
"field_id": 2
},
{
"field_name": "remark",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 3
}
],
"total": 7,
"count": 7
}
{
"result": [
{
"field_name": "Email",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Name",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Phone",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Gender",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 0
},
{
"field_name": "Birthday",
"field_type": 3,
"visible": true,
"format": "MM/DD",
"options": null,
"field_id": 1
},
{
"field_name": "Age",
"field_type": 1,
"visible": true,
"format": "0",
"options": null,
"field_id": 2
},
{
"field_name": "remark",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 3
}
],
"total": 7,
"count": 7
}
Tampilkan blok kode ini di jendela mengambang
Respon-Gagal
HTTP Status :401
{
"code": 30000,
"message": "Autentikasi gagal"
}
{
"code": 30000,
"message": "Autentikasi gagal"
}
Tampilkan blok kode ini di jendela mengambang
