Home › Patterns
Delete Pattern — FarazSMS SMS web service
DELETE https://api.iranpayamak.com/ws/v1/patterns/{code}
Purpose: Permanently delete one of your own patterns by its code — for clearing out test and retired patterns.
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.
Authentication
This endpoint requires the Api-Key header — get the key from the FarazSMS panel. The header name is case-sensitive and the key must never travel in a query string.
Notes for this endpoint
- Only patterns belonging to your account can be deleted; anything else returns 404.
- A pattern still used by a connected integration cannot be deleted and returns 400 with the reason.
- Deletion is irreversible. To pause a pattern instead, change its status in the panel.
- Past sends made with this pattern are unaffected; their reports remain.
Responses
200— Deleted400— The pattern is in use and cannot be deleted.404— No pattern with this code belongs to your account.