Create New Pattern

POST

https://api.iranpayamak.com/ws/v1/patterns

Create a new pattern with API

Request

Authorization

Add parameter in header

Api-Key

Example:

Api-Key: ********************

Header Params

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.iranpayamak.com/ws/v1/patterns' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "test text %var%, %var2%",
    "description": "test desc", // nullable
    "share": 1, // boolean
    "website": "example.com",
    "vars": [
        {
            "var": "var",
            "length": 12,
            "type": "int" // int, str, date
        },
        {
            "var": "var2",
            "length": 12,
            "type": "int" // int, str, date
        }
    ]
}'

Responses

🟢201Pattern created successfully.

application/json

Body

Example

{
    "status": "success",
    "data": "string",
    "messages": "string"
}

Modified at 2025-09-21 18:51:26

Delete Contact

Get Pattern Details