FarazSMS Public APIs
  1. Account
FarazSMS Public APIs
  • Account
    • Profile
      GET
    • Account Balance
      GET
    • update
      POST
    • Charge wallet
      POST
    • Register
      POST
  • Send
    • Send Sample SMS
      POST
    • Send Simple SMS
      POST
    • Send Simple SMS from Excel
      POST
    • Send SMS with Variables
      POST
    • Send SMS with Variables from Excel
      POST
    • Send Peer-to-Peer SMS
      POST
    • Send Peer-to-Peer SMS from Excel
      POST
    • Send Pattern-Based SMS
      POST
  • Phonebook
    • Get Phonebooks
      GET
    • Create New Phonebook
      POST
    • Get Phonebook Attributes
      GET
    • Create New Phonebook Attribute
      POST
    • Get Phonebook Contacts
      GET
  • Pattern
    • Create New Pattern
      POST
    • Get Pattern Details
      GET
    • Edit Pattern
      PUT
    • Get List of User's Patterns
      GET
  • Get Paged Inbox Messages
    GET
  1. Account

update

POST
/ws/v1/account/update

Request

Authorization
Add parameter in header
Api-Key
Example:
Api-Key: ********************
Header Params

Body Params application/json

Example
{
    "first_name": "Ali",
    "last_name": "Rezaei",
    "father_name": "Mohammad",
    "gender": 1, // 1 = men, 2 = women, 3 = other
    "national_code": "1234567890",
    "national_id": "A123456789",
    "br_date": 631152000, // Example UNIX timestamp (1990-01-01)
    "live_province_id": 2,
    "live_city_id": 20,
    "live_postal_code": "1234567890",
    "fixed_phone": "02112345678",
    "mobile": "09121234567",
    "email": "ali.rezaei@example.com",
    "address": "123 Example St, Cityname",
    "ceo": {
        "has_ceo": true,
        "first_name": "Sara",
        "last_name": "Ahmadi",
        "father_name": "Hossein",
        "gender": 1, // 1 = men, 2 = women, 3 = other
        "br_date": 599616000, // 1989-01-01
        "mobile": "09351234567",
        "national_id": "B987654321",
        "national_code": "9876543210"
    },
    "company": {
        "name": "Example Co",
        "national_id": "1122334455",
        "registration_id": "778899",
        "economic_id": "6655443322",
        "province_id": 3,
        "city_id": 30,
        "address": "456 Corporate Ave, Business City",
        "postal_code": "4433221100",
        "fixed_phone": "02187654321",
        "email": "info@exampleco.com"
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/ws/v1/account/update' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "Ali",
    "last_name": "Rezaei",
    "father_name": "Mohammad",
    "gender": 1, // 1 = men, 2 = women, 3 = other
    "national_code": "1234567890",
    "national_id": "A123456789",
    "br_date": 631152000, // Example UNIX timestamp (1990-01-01)
    "live_province_id": 2,
    "live_city_id": 20,
    "live_postal_code": "1234567890",
    "fixed_phone": "02112345678",
    "mobile": "09121234567",
    "email": "ali.rezaei@example.com",
    "address": "123 Example St, Cityname",
    "ceo": {
        "has_ceo": true,
        "first_name": "Sara",
        "last_name": "Ahmadi",
        "father_name": "Hossein",
        "gender": 1, // 1 = men, 2 = women, 3 = other
        "br_date": 599616000, // 1989-01-01
        "mobile": "09351234567",
        "national_id": "B987654321",
        "national_code": "9876543210"
    },
    "company": {
        "name": "Example Co",
        "national_id": "1122334455",
        "registration_id": "778899",
        "economic_id": "6655443322",
        "province_id": 3,
        "city_id": 30,
        "address": "456 Corporate Ave, Business City",
        "postal_code": "4433221100",
        "fixed_phone": "02187654321",
        "email": "info@exampleco.com"
    }
}'

Responses

🟢200OK
application/json
Body

Example
{}
Modified at 2025-09-30 21:58:22
Previous
Account Balance
Next
Charge wallet
Built with