การจัดการแท็กแคมเปญ
URL ส่วนท้าย (Endpoint)
| ศูนย์ข้อมูล | URL |
|---|---|
| สิงคโปร์ | https://email.api.engagelab.cc |
| ตุรกี | https://emailapi-tr.engagelab.com |
เมื่อใช้งาน REST API ให้รวม base URL ที่เลือกเข้ากับเส้นทางของ API ที่เฉพาะเจาะจง เพื่อรับ URL ของ endpoint ที่สมบูรณ์
POST/v1/marketing/campaigns/tags
สร้างแท็กแคมเปญ
URL
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP (HTTP Method)
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวการร้องขอ (Request Headers)
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์ใน Body (Body Parameters)
| Parameter | Type | Required | Description |
|---|---|---|---|
| tag_names | array[string] | true | ชื่อแท็ก ความยาวสูงสุด 64 ตัวอักษร รองรับเฉพาะ a-z, A-Z, 0-9, _, ตัวอักษรจีน เป็นต้น |
หมายเหตุ:
แต่ละองค์กร (Organization) สามารถสร้างแท็กได้สูงสุด 100 แท็ก
ชื่อแท็กห้ามซ้ำกัน
ตัวอย่างการร้องขอ (Request Example)
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{
"tag_names": ["โปรโมชัน_11_11", "ผู้ใช้ใหม่"]
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{
"tag_names": ["โปรโมชัน_11_11", "ผู้ใช้ใหม่"]
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างการตอบกลับ (Response Example)
Response-Success
HttpStatus: 200
{
"count": 2
}
{
"count": 2
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-Error
HttpStatus: 401
{
"code": 32603,
"message": "tag name already exist"
}
{
"code": 32603,
"message": "tag name already exist"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รายการแท็กแคมเปญ
URL
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP (HTTP Method)
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวการร้องขอ (Request Headers)
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์ของ Query (Query Parameters)
| Parameter | Type | Required | Description |
|---|---|---|---|
| tag_name | string | false | ชื่อแท็ก (ค้นหาแบบคลุมเครือ/Fuzzy Search) |
| offset | integer | false | ตําแหน่งเริ่มต้นของข้อมูล ช่วงค่า [0-] ค่าเริ่มต้นคือ 0 |
| limit | integer | false | จำนวนข้อมูลที่ต้องการดึง ช่วงค่า [1-100] ค่าเริ่มต้นคือ 10 |
ตัวอย่างการร้องขอ (Request Example)
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=โปรโมช](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=โปรโมช)ัน&limit=10&offset=0
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=โปรโมช](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=โปรโมช)ัน&limit=10&offset=0
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ (Response Fields)
| Parameter | Type | Description |
|---|---|---|
| tag_id | string | ไอดีแท็ก (Tag ID) |
| tag_name | string | ชื่อแท็ก |
| create_time | string | เวลาที่สร้าง |
| update_time | string | เวลาที่อัปเดต |
ตัวอย่างการตอบกลับ (Response Example)
Response-Success
HttpStatus: 200
{
"result": [
{
"tag_id": "64a1f2e0c9e1a23456789012",
"tag_name": "โปรโมชัน_11_11",
"create_time": "2024-01-15T10:30:00+0800",
"update_time": "2024-01-16T14:20:00+0800"
},
{
"tag_id": "64a1f2e0c9e1a23456789013",
"tag_name": "ผู้ใช้ใหม่",
"create_time": "2024-01-14T08:00:00+0800",
"update_time": "2024-01-14T08:00:00+0800"
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"tag_id": "64a1f2e0c9e1a23456789012",
"tag_name": "โปรโมชัน_11_11",
"create_time": "2024-01-15T10:30:00+0800",
"update_time": "2024-01-16T14:20:00+0800"
},
{
"tag_id": "64a1f2e0c9e1a23456789013",
"tag_name": "ผู้ใช้ใหม่",
"create_time": "2024-01-14T08:00:00+0800",
"update_time": "2024-01-14T08:00:00+0800"
}
],
"total": 2,
"count": 2
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
อัปเดตแท็กแคมเปญ
URL
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP (HTTP Method)
PUT
PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวการร้องขอ (Request Headers)
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์ใน Path (Path Parameters)
| Parameter | Type | Required | Description |
|---|---|---|---|
| tag_id | string | true | ไอดีแท็ก (Tag ID) |
พารามิเตอร์ใน Body (Body Parameters)
| Parameter | Type | Required | Description |
|---|---|---|---|
| tag_name | string | true | ชื่อแท็ก รองรับเฉพาะตัวอักษรจีน, ภาษาอังกฤษตัวพิมพ์ใหญ่และเล็ก, ตัวเลข และเครื่องหมายขีดล่าง (_) ความยาว 1-64 ตัวอักษร |
ตัวอย่างการร้องขอ (Request Example)
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{
"tag_name": "โปรโมชันกลางปี"
}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{
"tag_name": "โปรโมชันกลางปี"
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างการตอบกลับ (Response Example)
Response-Success
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-Error
HttpStatus: 401
{
"code": 32605,
"message": "Campaign tag not found"
}
{
"code": 32605,
"message": "Campaign tag not found"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
ลบแท็กแคมเปญ
URL
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP (HTTP Method)
DELETE
DELETE
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวการร้องขอ (Request Headers)
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
หมายเหตุ:
- หลังจากลบแท็กแล้ว แคมเปญ (campaign) ที่เกี่ยวข้องจะถูกนำแท็กนี้ออกโดยอัตโนมัติ
ตัวอย่างการร้องขอ (Request Example)
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f)
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f)
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างการตอบกลับ (Response Example)
Response-Success
HttpStatus: 200
{
"count": 2
}
{
"count": 2
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-Error
HttpStatus: 401
{
"code": 32606,
"message": "tag_id cannot be empty"
}
{
"code": 32606,
"message": "tag_id cannot be empty"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
เพิ่มแท็กให้กับแคมเปญ
URL
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP (HTTP Method)
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวการร้องขอ (Request Headers)
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์ใน Body (Body Parameters)
| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_ids | array[string] | * | รายการไอดีแคมเปญ (Campaign ID) สูงสุด 200 ไอดีต่อหนึ่งคำขอ |
หมายเหตุ:
- แต่ละแคมเปญสามารถเพิ่มแท็กได้สูงสุด 20 แท็ก
ตัวอย่างการร้องขอ (Request Example)
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{
"campaign_ids": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{
"campaign_ids": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างการตอบกลับ (Response Example)
Response-Success
HttpStatus: 200
{
"total": 3
}
{
"total": 3
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-Error
HttpStatus: 401
{
"code": 32605,
"message": "Campaign tag not found"
}
{
"code": 32605,
"message": "Campaign tag not found"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
ย้ายแท็กออกจากแคมเปญ
URL
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove
[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP (HTTP Method)
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวการร้องขอ (Request Headers)
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์ใน Body (Body Parameters)
| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_ids | array[string] | * | รายการไอดีแคมเปญ (Campaign ID) สูงสุด 200 ไอดีต่อหนึ่งคำขอ |
ตัวอย่างการร้องขอ (Request Example)
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{
"campaign_ids": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{
"campaign_ids": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างการตอบกลับ (Response Example)
Response-Success
HttpStatus: 200
{
"total": 3
}
{
"total": 3
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-Error
HttpStatus: 401
{
"code": 32605,
"message": "Campaign tag not found"
}
{
"code": 32605,
"message": "Campaign tag not found"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
