Add WhatsApp Contact

This page contains the API documentation for the adding new WhatsApp contacts.


The Inbox User Import API allows you to import WhatsApp contacts into the BotPenguin platform. You can use this API to create or update WhatsApp contacts with various attributes and contact information.

Base URL


To use this API, you need to include the following authentication header:

  • Authorization: Bearer Token

    • Example: Bearer eyJhbGciO*****InR5cCI6IkpXVCJ9...

Request Headers

The following request headers are required:

  • Content-Type: application/json

Request Data

The request should include a JSON array of user profiles to be imported. Each user profile should have the following structure:

jsonCopy code[
    "profile": {
      "userDetails": {
        "userProvidedName": "User Name",
        "contact": {
          "email": "",
          "phone": {
            "number": "1234567890",
            "prefix": "91"
        "tags": [],
        "attributes": []

Example CURL Request

curl '' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Origin:' \
  -H 'Referer:' \
  -H 'Sec-Fetch-Dest: empty' \
  -H 'Sec-Fetch-Mode: cors' \
  -H 'Sec-Fetch-Site: same-site' \
  -H 'User-Agent: Your User-Agent' \
  --data-raw '[{"profile":{"userDetails":{"userProvidedName":"User Name","contact":{"email":"","phone":{"number":"1234567890","prefix":"91"}},"tags":[],"attributes":[]}}}]' \


The API will respond with a status code and a JSON response body. The response body will contain information about the import operation.

  • Status Codes:

    • 200 OK: The import operation was successful.

Example Response

jsonCopy code{
  "status": "success",
  "message": "User profiles imported successfully."


The Inbox User Import API allows you to easily import user profiles into the BotPenguin platform. Make sure to follow the authentication and data format guidelines for successful imports.

❓ Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at

Last updated