1. Phonebook
Nabd Messaging
  • WhatsApp
    • Send a text message (WhatsApp)
      POST
    • Send an image or document (WhatsApp)
      POST
    • Send a saved template (WhatsApp)
      POST
    • Check whether a phone number is on WhatsApp
      POST
    • Resolve a WhatsApp identity (phone, WhatsApp ID, or username)
      POST
    • List WhatsApp chats
      POST
    • List WhatsApp groups
      POST
    • Read the WhatsApp device status
      POST
  • Telegram
    • Send a text message (Telegram)
      POST
    • Send an image or document (Telegram)
      POST
    • Send a saved template (Telegram)
      POST
    • List Telegram chats and dialogs
      POST
    • List Telegram groups and channels
      POST
    • Read the Telegram account status
      POST
  • Templates
    • List templates
      POST
    • Get a template
      POST
  • Messages
    • List sent messages
      POST
    • Get a sent message
      POST
  • Phonebook
    • List contacts
      POST
    • Create a contact
      POST
    • Update a contact
      POST
    • Delete a contact
      POST
    • List contact groups
      POST
    • Create a contact group
      POST
    • Delete a contact group
      POST
    • Add contacts to a group
      POST
    • Remove contacts from a group
      POST
  • Scheduling
    • Schedule a message
    • List scheduled messages
    • Cancel a scheduled message
  • Account
    • Read account usage and limits
  • Schemas
    • AuthKeys
    • AuthKeyOnlyRequest
    • AuthAppRequest
    • WhatsAppSendTextRequest
    • ContactsResponse
    • WhatsAppSendMediaRequest
    • SendTemplateRequest
    • GroupsResponse
    • TelegramSendTextRequest
    • TelegramSendMediaRequest
    • ResolveResponse
    • NumberCheckRequest
    • LookupRequest
    • ValidationError
    • ChatsRequest
    • UsernameError
    • TemplatesListRequest
    • WaServerError
    • TemplatesGetRequest
    • WaDeviceNotConnected
    • MessagesListRequest
    • MessagesGetRequest
    • ResolveRateLimit
    • ContactsListRequest
    • ContactsCreateRequest
    • RateLimitAny
    • ContactsUpdateRequest
    • ReqIdRequest
    • ReqGroupIdRequest
    • ReqScheduleIdRequest
    • ContactGroupsCreateRequest
    • AddRemoveContactsRequest
    • ScheduleCreateRequest
    • ScheduleListRequest
    • Envelope
    • PaginatedEnvelope
    • Error
    • RateLimitExceededSchema
    • LookupResponse
    • ChatsResponse
    • GroupsChatsResponse
    • TelegramDialogsResponse
    • ContactItem
    • AuthRequest
    • ContactsRequest
    • CreateMessageRequest
    • CreateMessageResponse
    • ResolveRequest
    • AuthError
    • RateLimitExceeded
    • SendBlocked
  1. Phonebook

Create a contact

POST
/api/contacts/create
Last modified:2026-09-29 09:27:11
Add a contact to the phonebook.
At least one address is required — phone, a WhatsApp username
(whatsapp_username), a Telegram user ID, or a Telegram username. A
phone value that parses as a WhatsApp username is stored as the
username.
name: required, max 50 characters.
phone: optional; a WhatsApp phone (the WhatsAppRecipient rule).
whatsapp_username: optional; with or without a leading @.
telegram_user_id: optional integer. telegram_username: optional
string, max 100 characters.
group_ids: optional array of up to 50 group IDs to add the contact to.
Any group that does not exist for the account answers 404 NOT_FOUND
and the contact is not created.
A duplicate phone or WhatsApp username answers 409 CONTACT_EXISTS
with the existing contact's contact_id.
The plan's contact limit applies (403 when reached).

Request

Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Contact created.
Bodyapplication/json

🟠409
🟠401Error401
🟠403Error403
🟠404Error404
🟠422Error422
🟠429Error429
🔴500Error500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/api/contacts/create' \
--header 'Content-Type: application/json' \
--data '{
    "authkey": "{{authkey}}",
    "name": "Retail Client",
    "phone": "+966 50 123 4567"
}'
Response Response Example
201 - success
{
    "success": true,
    "data": {
        "contact_id": 7,
        "name": "Retail Client",
        "phone": "966501234567",
        "whatsapp_username": null,
        "whatsapp_id": null,
        "telegram_user_id": null,
        "telegram_username": null,
        "groups": [],
        "created_at": "2026-09-29T10:00:00+03:00"
    }
}
Modified at 2026-09-29 09:27:11
Previous
List contacts
Next
Update a contact
Built with