حذف کارمند (Delete: User Whitelist)
برای حذف کارمندان از لیست مجاز این کد تخفیف حذف استفاده میشود.
اطلاعات عمومی
- آدرس:
/api/v2/purchased-voucher/{id}/user-whitelist - متد:
DELETE - نوع محتوا:
application/json - احراز هویت: نیازمند token
احراز هویت
- این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.
پارامترهای مسیر
| پارامتر | نوع داده | ضروری | توضیحات |
|---|---|---|---|
| id | integer | بله | شناسه کد تخفیف خریداری‌شده |
پارامترهای بدنه درخواست (Request Body)
| فیلد | نوع داده | ضروری | توضیحات |
|---|---|---|---|
| cellphone | string | بله | شماره تلفن همراه کاربر برای حذف از لیست سفید |
نمونه Request Body:
{
"cellphone": "09121234567"
}
نمونه درخواست
curl --location --request DELETE 'https://corporate.snapp.site/api/v2/purchased-voucher/5113/user-whitelist' \
--header 'Authorization: <your_authorization_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"cellphone": "09121234567"
}'
پاسخ موفق
{
"message": "OK",
"status": 0
}
توضیحات فیلدهای پاسخ
| فیلد | نوع داده | توضیحات |
|---|---|---|
| message | string | پیام کلی پاسخ (مثلاً "OK") |
| status | integer | کد وضعیت پاسخ (0 برای موفقیت) |
خطاها
| کد وضعیت | توضیحات |
|---|---|
400 | درخواست نامعتبر (ورودی‌های اشتباه) |
401 | نیاز به احراز هویت |
403 | دسترسی غیرمجاز |
404 | کد تخفیف موردنظر یافت نشد |
500 | خطای داخلی سرور |