Home › Phonebook & Contacts

Update Phonebook — FarazSMS SMS web service

PUT https://api.iranpayamak.com/ws/v1/phone_book/{id}

Purpose: Rename or change the columns of an existing phonebook.

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

• title (string) — required
• attributes (array) — optional

Notes for this endpoint

• Edits an existing phonebook by id.

Example body

{
  "title": "updated title",
  "attributes": [
    1,
    3
  ]
}

Responses

• 201 — Phonebook created successfully.

Related endpoints in Phonebook & Contacts

• GET /example/phone-book/{phone_book}/data.xlsx — Get Bulk Excel Sample
• POST /ws/v1/phone_book — Create New Phonebook
• GET /ws/v1/phone_book — Get Phonebooks
• POST /ws/v1/phone_book_attribute — Create New Phonebook Attribute
• GET /ws/v1/phone_book_attribute — Get Phonebook Attributes
• POST /ws/v1/phone_book_data — Add New Contact
• GET /ws/v1/phone_book_data — Get Phonebook Contacts
• POST /ws/v1/phone_book_data/bulk-upsert — Add Bulk Contact

All FarazSMS web services · llms.txt · OpenAPI