فراز اس ام اس مستندات وب‌سرویس

خانه › مدیریت پترن

حذف پترن — وب سرویس پیامک فراز اس ام اس

DELETE https://api.iranpayamak.com/ws/v1/patterns/{code}

کاربرد: حذف دائمیِ یکی از پترن‌های خودتان، با کد پترن. برای پاک‌سازی پترن‌های آزمایشی و از‌رده‌خارج.

Permanently delete one of your own patterns, addressed by its code. A pattern that is still in use by a connected integration cannot be deleted and returns 400 with the reason.

احراز هویت

این سرویس به هدر Api-Key نیاز دارد — کلید را از پنل فراز اس ام اس بگیرید. نام هدر حساس به حروف بزرگ و کوچک است و کلید نباید در query string برود.

نکات مهم این سرویس

  • فقط پترن‌های حساب خودتان قابل حذف‌اند؛ در غیر این صورت پاسخ ۴۰۴ می‌گیرید.
  • اگر پترن در یکی از سرویس‌های یکپارچه‌شده استفاده شده باشد، حذف نمی‌شود و پاسخ ۴۰۰ با توضیح می‌گیرید.
  • حذف برگشت‌ناپذیر است. اگر فقط می‌خواهید موقتاً استفاده نشود، به‌جای حذف، وضعیتش را در پنل تغییر دهید.
  • ارسال‌های گذشته‌ای که با این پترن انجام شده‌اند از بین نمی‌روند؛ گزارششان باقی می‌ماند.

پاسخ‌ها

  • 200 — Deleted
  • 400 — The pattern is in use and cannot be deleted.
  • 404 — No pattern with this code belongs to your account.

سرویس‌های مرتبط در دستهٔ «مدیریت پترن»

همه‌ی وب‌سرویس‌های فراز اس ام اس · llms.txt · OpenAPI