ลบรายชื่อผู้ติดต่อ POST
ลบรายชื่อผู้ติดต่อออกจากบัญชีของคุณ รายชื่อที่ลบแล้วจะไม่แสดงในค้นหารายชื่อและแก้ไขต่อไม่ได้
Authorization
ใช้ API Key (การยืนยันตัวตน) — ส่ง header Authorization: Bearer <API_KEY> (API Key ขึ้นต้นด้วย smsk_)
HTTP Request
http
POST https://public-api.smsup-plus.com/Person/deletePersonContent Type
application/json
Parameter Description
| Property | Type | Required | Description |
|---|---|---|---|
personId | string | Required | รหัสรายชื่อที่ต้องการลบ (ต้องเป็นของบัญชีคุณ) |
Response Description
| Property | Type | Description |
|---|---|---|
status | number | 200 เมื่อสำเร็จ |
description | string | Person deleted. |
ตัวอย่าง Request
bash
curl -X POST 'https://public-api.smsup-plus.com/Person/deletePerson' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"personId": "3f8b2c1e-7a4d-4e9b-9c2f-1d5e6a7b8c90"
}'js
const res = await fetch('https://public-api.smsup-plus.com/Person/deletePerson', {
method: 'POST',
headers: { Authorization: 'Bearer <API_KEY>', 'Content-Type': 'application/json' },
body: JSON.stringify({ personId: '3f8b2c1e-7a4d-4e9b-9c2f-1d5e6a7b8c90' }),
})
console.log(await res.json())ตัวอย่าง Response
json
{
"status": 200,
"description": "Person deleted."
}Error ที่อาจเจอ
| HTTP | Response | สาเหตุ |
|---|---|---|
| 200 | {"status":400,"description":"personId is required."} | ไม่ได้ส่ง personId หรือ body ไม่ใช่ JSON |
| 200 | {"status":404,"description":"Person not found."} | ไม่พบรายชื่อ ถูกลบไปแล้ว หรือไม่ใช่ของบัญชีคุณ |
| 200 | {"status":500,"description":"Failed to delete person."} | ลบไม่สำเร็จ ลองใหม่อีกครั้ง |
| 401 | {"error":"invalid api key"} | API Key ไม่ถูกต้อง — ดู Error |
WARNING
เมื่อผ่านการยืนยันตัวตนแล้ว endpoint นี้ตอบ HTTP 200 เสมอ ให้ตรวจผลจากฟิลด์ status ใน body
INFO
การลบรายชื่อไม่ได้ลบช่องทางติดต่อ (destination) หรือการผูกแท็กของรายชื่อนั้นไปด้วย — ถ้าต้องการลบ ให้เรียก ลบช่องทางติดต่อ และ ยกเลิกการผูกแท็ก ก่อนลบรายชื่อ
