Home › Patterns

Edit Pattern — FarazSMS SMS web service

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

Purpose: Edit an existing pattern's text or variables (may require re-approval).

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.

Request fields

• text (string) — required
• description (string) — optional
• shared (boolean) — required
• website (string) — required
• attributes (array) — optional

Notes for this endpoint

• Edit an existing pattern by code. Edits may require re-approval.

Example body

{
  "text": "test text %var%, %var2%",
  "description": "test desc",
  "share": 1,
  "website": "example.com",
  "vars": [
    {
      "var": "var",
      "length": 12,
      "type": "int"
    },
    {
      "var": "var2",
      "length": 12,
      "type": "int"
    }
  ]
}

Responses

• 201 — Pattern created successfully.

Related endpoints in Patterns

• POST /ws/v1/patterns — Create New Pattern
• GET /ws/v1/patterns — Get List of User's Patterns

All FarazSMS web services · llms.txt · OpenAPI