logoเอกสาร
Email
หน้าหลักเอกสาร
เริ่มต้นด่วนคำแนะนำREST APISMTPการตลาดWebHookทรัพยากร
ค้นหา
ภาษาไทย
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Bahasa Indonesia
เข้าสู่ระบบ
REST API / การตลาด / การจัดการแท็ก

การจัดการแท็ก

อัพเดทล่าสุด ：2025-07-22

ที่อยู่การโทร

ศูนย์ข้อมูล URL
สิงคโปร์ https://email.api.engagelab.cc
ตุรกี https://emailapi-tr.engagelab.com

เมื่อใช้ REST API ให้แน่ใจว่าศูนย์ข้อมูลที่เลือกตรงกับ URL พื้นฐานที่เหมาะสม

POST/v1/marketing/lists/tags

สร้างแท็ก

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags
              
              https://email.api.engagelab.cc/v1/marketing/lists/tags
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST
              
              POST
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

พารามิเตอร์ในเนื้อหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
tag_name string true ชื่อแท็ก สูงสุด 64 ตัวอักษร ประกอบด้วย a-z, A-Z, 0-9, _, อักษรจีน เป็นต้น

ตัวอย่างคำขอ

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"
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ

Response-Success

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",
    }
      
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }
              
              {
    "code": 30000,
    "message": "Authentication failed"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

ลบแท็ก

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DELETE
              
              DELETE
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type

application/x-www-form-urlencoded;charset=utf-8
              
              application/x-www-form-urlencoded;charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

ตัวอย่างคำขอ

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
โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ

Response-Success

HttpStatus: 200

{ "count": 1 }
              
              {
   "count": 1
 }
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-Error

{ "code": 30036, "message": "resource not found" }
              
              {
    "code": 30036,
    "message": "resource not found"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

อัปเดตแท็ก

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

PUT
              
              PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

พารามิเตอร์ในเนื้อหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
tag_name string false ชื่อแท็ก สูงสุด 64 ตัวอักษร ประกอบด้วย a-z, A-Z, 0-9, _, อักษรจีน เป็นต้น

ตัวอย่างคำขอ

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{ "name": "myCustomTag" }'
              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{
  "name": "myCustomTag"
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ

Response-Success

HttpStatus: 200

{ "count": 1 }
              
              {
   "count": 1
 }
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-Error

HttpStatus: 400

{ "code": 30035, "message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters" }
              
              {
    "code": 30035,
    "message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

รายการแท็ก

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags
              
              https://email.api.engagelab.cc/v1/marketing/lists/tags
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET
              
              GET
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type

application/x-www-form-urlencoded;charset=utf-8
              
              application/x-www-form-urlencoded;charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

พารามิเตอร์การค้นหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
tag_name string false ชื่อแท็กที่ต้องการค้นหา (รองรับการค้นหาแบบคลุมเครือ)
offset integer false ตำแหน่งเริ่มต้นของการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0
limit integer false จำนวนการค้นหา ช่วง [1-100] ค่าเริ่มต้นคือ 10

ตัวอย่างคำขอ

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
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์ ประเภท คำอธิบาย
result array[object] รายการผู้ติดต่อ
tag_id string ID ของแท็ก
tag_name string ชื่อแท็ก
create_time string เวลาที่สร้าง
update_time string เวลาที่อัปเดต
count integer จำนวนผู้ติดต่อที่มีแท็กนี้
total integer จำนวนรายการทั้งหมดที่ตรงกับการค้นหา
count integer จำนวนรายการที่ส่งกลับทั้งหมด

ตัวอย่างการตอบกลับ

Response-Success

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
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }
              
              {
    "code": 30000,
    "message": "Authentication failed"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

เพิ่มแท็กให้กับผู้ติดต่อ

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
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST
              
              POST
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization string true Basic base64(api_user:api_key)

พารามิเตอร์ในเนื้อหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
member_ids string[] true รายการ ID ของผู้ติดต่อ สูงสุด 1000 ID ต่อคำขอ

ตัวอย่างคำขอ

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" ] }'
              
              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"
  ]
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ

Response-Success

HttpStatus: 200

{ "count": 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/lists/tags/{tag_id}/remove
              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST
              
              POST
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization string true Bearer Token

พารามิเตอร์ในเนื้อหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
member_ids array[string] true รายการ ID ของผู้ติดต่อ สูงสุด 1000 ID ต่อคำขอ

ตัวอย่างคำขอ

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/ 616683a13a7b531b0336108d/remove --data '{ "memberIds": [ "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/lists/tags/ 616683a13a7b531b0336108d/remove --data '{
  "memberIds": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ

Response-Success

HttpStatus:200

{ "count": 1 }
              
              {
    "count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

HttpStatus: 401

Response-Error

{ "code": 30000, "message": "Authentication failed" }
              
              {
    "code": 30000,
    "message": "Authentication failed"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

รับรายชื่อผู้ติดต่อ

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
โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET
              
              GET
โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type

application/x-www-form-urlencoded;charset=utf-8
              
              application/x-www-form-urlencoded;charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว ประเภท จำเป็น คำอธิบาย
Authorization string true Bearer Token

คำอธิบายการค้นหา

พารามิเตอร์ ประเภท จำเป็น คำอธิบาย
offset integer false ตำแหน่งเริ่มต้นของการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0
limit integer false จำนวนการค้นหา ช่วง [1-100] ค่าเริ่มต้นคือ 10

ตัวอย่างคำขอ

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
โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์ ประเภท คำอธิบาย
result object รายการผู้ติดต่อ
member_id string ID ของผู้ติดต่อ
list_id integer ID ของรายการ
email string ที่อยู่อีเมล
phone string หมายเลขโทรศัพท์
name string ชื่อ
create_time string เวลาที่สร้าง (UTC+8)
update_time string เวลาที่อัปเดต (UTC+8)
unsubscribe_time string เวลายกเลิกการสมัคร (UTC+8)
fields object คุณลักษณะของผู้ติดต่อ
tag_ids array[string] คอลเลกชัน ID ของแท็ก
tag_names array[string] คอลเลกชันชื่อแท็ก
total integer จำนวนรายการทั้งหมดที่ตรงกับการค้นหา

ตัวอย่างการตอบกลับ

Response-Success

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
}
โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }
              
              {
    "code": 30000,
    "message": "Authentication failed"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
icon
ติดต่อฝ่ายขาย