Home › Patterns

Get Pattern Details — FarazSMS SMS web service

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

Purpose: View one pattern's details (variable names and count) so your send matches it exactly.

This endpoint help to get a pattern by its "code"

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

• Gets a single pattern by its code — to see its variable names and count.
• Check the variable names here so your send matches them.

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