FarazSMS Public APIs
  1. LBS
FarazSMS Public APIs
  • Auth
    • Login
      POST
    • Register
      POST
    • Verify 2fa
      POST
    • Show Register Form
      GET
    • Logout
      POST
  • Account
    • Profile
      GET
    • Account Balance
      GET
    • update
      POST
    • Charge wallet
      POST
    • Register
      POST
    • Lines
      GET
  • 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
    • Update Phonebook
      PUT
    • Get Phonebook Attributes
      GET
    • Create New Phonebook Attribute
      POST
    • Get Phonebook Contacts
      GET
    • Add New Contact
      POST
    • Delete Contact
      DELETE
  • Pattern
    • Create New Pattern
    • Get Pattern Details
    • Edit Pattern
    • Get List of User's Patterns
  • LBS
    • index
      GET
    • store
      POST
    • show
      GET
    • update
      PUT
    • cancel
      PATCH
  • Order
    • pay
    • apply discount
    • cancel
  • Get Paged Inbox Messages
    GET
  • Schemas
    • Schemas
      • SelfSampleRequestDto
      • SimpleRequestDto
      • ApiResultString
      • SimpleFileRequestDto
      • ApiResultPagedPhonebook
      • KeywordRequestDto
      • ApiResultPagedPhonebookAttribute
      • KeywordFileRequestDto
      • ApiResultPagedPhonebookData
      • PeerToPeerRequestDto
      • ApiResultPagedInbox
      • PeerToPeerFileRequestDto
      • PagedPhonebook
      • ApiResultNumber
      • PagedPhonebookAttribute
      • ApiResultNumberArray
      • PagedPhonebookData
      • PagedInboxMessages
      • PhonebookAttribute
      • Phonebook
      • PhonebookDataAttribute
      • PhonebookDataRecord
      • PhonebookCreateRequestDto
      • PhonebookAttributeCreateRequestDto
      • InboxMessage
      • PatternAttribute
      • PatternRequestDto
      • PatternSendRequestDto
    • ApiMessage
    • ApiStatus
  1. LBS

update

PUT
https://api.iranpayamak.com/ws/v1/lbs/{lbsId}

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Header Params

Body Params application/json

Example
{
    "text": "test text",
    "start_time": 1742773823,
    "end_time": 1742774823,
    "receiver_count": 10000,
    "latitude": 45,
    "longitude": 90,
    "radius": 1000,
    "address": "some address",
    "dispatch_moment": "حضور", // 'ورود', 'حضور', 'خروج'
    "receiver_gender": "مرد", // 'همه', 'مرد', 'زن'
    "receiver_age_from": 12,
    "receiver_age_to": 90,
    "device": "Android", // 'همه', 'Android', 'IOS'
}

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 PUT 'https://api.iranpayamak.com/ws/v1/lbs/5' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "test text",
    "start_time": 1742773823,
    "end_time": 1742774823,
    "receiver_count": 10000,
    "latitude": 45,
    "longitude": 90,
    "radius": 1000,
    "address": "some address",
    "dispatch_moment": "حضور", // '\''ورود'\'', '\''حضور'\'', '\''خروج'\''
    "receiver_gender": "مرد", // '\''همه'\'', '\''مرد'\'', '\''زن'\''
    "receiver_age_from": 12,
    "receiver_age_to": 90,
    "device": "Android", // '\''همه'\'', '\''Android'\'', '\''IOS'\''
}'

Responses

🟢200
application/json
Body

Example
{}
Modified at 2025-12-20 10:16:08
Previous
show
Next
cancel
Built with