Home › Phonebook & Contacts

Create New Phonebook — FarazSMS SMS web service

POST https://api.iranpayamak.com/ws/v1/phone_book

Purpose: Create a new phonebook to group your contacts.

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

• Creates a new phonebook (title required). attributes are custom columns.

Example body

{
  "title": "test title",
  "attributes": [
    2
  ]
}

Responses

• 201 — Phonebook created successfully.

Related endpoints in Phonebook & Contacts

• GET /example/phone-book/{phone_book}/data.xlsx — Get Bulk Excel Sample
• PUT /ws/v1/phone_book/{id} — Update Phonebook
• 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
• POST /ws/v1/phone_book_data/excel-upsert — Add Excel Contact

All FarazSMS web services · llms.txt · OpenAPI