WhatsApp

WhatsApp

Get all Business Manager Accounts

get

Responses

200

Successful response

application/json

401

Unauthorized

application/json

get

/api/whatsapp/business-manager-accounts

HTTPcURLJavaScriptPython

GET /api/whatsapp/business-manager-accounts HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Business accounts fetched successfully.",
  "data": [
    {
      "id": "text",
      "name": "text",
      "link": "text",
      "profile_picture_uri": "text",
      "two_factor_type": "text",
      "verification_status": "text",
      "vertical": "text",
      "whatsapp_business_accounts": [
        {
          "id": "text",
          "name": "text",
          "currency": "text",
          "message_template_namespace": "text"
        }
      ]
    }
  ]
}

Display a specific Business Manager Account

get

Fetches a specific Business Manager Account by its ID.

Path parameters

idstringRequired

The ID of the Business Manager Account to retrieve.

Responses

200

Business Manager Account fetched successfully.

application/json

404

Account not found

application/json

get

/api/whatsapp/business-manager-accounts/{id}

HTTPcURLJavaScriptPython

GET /api/whatsapp/business-manager-accounts/{id} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Business Manager account fetched successfully.",
  "data": {
    "id": "text",
    "name": "text",
    "link": "text",
    "profile_picture_uri": "text",
    "two_factor_type": "text",
    "verification_status": "text",
    "vertical": "text",
    "whatsapp_business_accounts": [
      {
        "id": "text",
        "name": "text",
        "currency": "text",
        "message_template_namespace": "text"
      }
    ]
  }
}

Onboard a WhatsApp business account

post

Exchanges an authorization code for an access token and retrieves the Business Manager ID associated with the WhatsApp Business Account.

Body

application/json

codestringRequired

The authorization code to exchange for an access token.

whatsapp_business_account_idstringRequired

The WhatsApp Business Account ID.

Responses

200

Onboarding successful

application/json

400

Bad request due to missing required parameters or failed operations

application/json

post

/api/whatsapp/onboard

HTTPcURLJavaScriptPython

POST /api/whatsapp/onboard HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "code": "text",
  "whatsapp_business_account_id": "text"
}

{
  "success": true,
  "message": "Onboarding successful",
  "data": {
    "business_manager_id": "123456789012345"
  }
}

Get WhatsApp business profile by phone number ID

get

Fetches the WhatsApp business profile for a specified phone number ID.

Path parameters

phoneNumberIDstringRequired

The ID of the phone number associated with the WhatsApp business profile.

Example: 108427225641466

Responses

200

Successful response with business profile

application/json

400

Failed to fetch business profile

application/json

get

/api/whatsapp/whatsapp-business-profile/{phoneNumberID}

HTTPcURLJavaScriptPython

GET /api/whatsapp/whatsapp-business-profile/{phoneNumberID} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Business profile fetched successfully.",
  "data": {
    "id": "108427225641466",
    "whatsapp_business_account_id": "109346662215398",
    "whatsapp_phone_number_id": "108427225641466",
    "about": "Leading provider of innovative solutions.",
    "address": "123 Business St, Business City, BC 12345",
    "description": "We provide top-quality products and services.",
    "email": "[email protected]",
    "profile_picture_url": "https://example.com/profile-picture.jpg",
    "vertical": "Retail"
  }
}

Get phone numbers for a WhatsApp business account

get

Fetches phone numbers associated with a specified WhatsApp business account, and returns the stored phone numbers.

Path parameters

whatsapp_business_account_idstringRequired

The ID of the WhatsApp business account.

Example: 109346662215398

Responses

200

Successful response with phone numbers

application/json

400

Failed to fetch phone numbers

application/json

get

/api/whatsapp/whatsapp-phone-numbers/{whatsapp_business_account_id}

HTTPcURLJavaScriptPython

GET /api/whatsapp/whatsapp-phone-numbers/{whatsapp_business_account_id} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Phone numbers fetched successfully.",
  "data": [
    {
      "id": 1906385232743451,
      "verified_name": "Jasper's Market",
      "code_verification_status": "EXPIRED",
      "display_phone_number": "[phone]",
      "quality_rating": "GREEN",
      "platform_type": "CLOUD_API"
    }
  ]
}