Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authentication: X-Auth-ID, X-Auth-Token, Accept: application/json

​
List WhatsApp channels

GET https://api.vobiz.ai/v1/messaging/channels/whatsapp
Returns all WhatsApp channels connected to your Vobiz account.
cURL
curl -X GET \
  "https://api.vobiz.ai/v1/messaging/channels/whatsapp" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"
200 OK
{
  "data": [{
    "id": "2f8892e1-59b7-40a2-b518-e7a7c31a754d",
    "display_name": "My Business",
    "phone_number": "+15551234567",
    "waba_id": "1911116896216319",
    "status": "active",
    "created_at": "2026-03-01T10:00:00Z"
  }]
}

​
Create WhatsApp channel

POST https://api.vobiz.ai/v1/messaging/channels/whatsapp
Connect a new WhatsApp Business number using your WABA credentials from Meta Business Manager.
FieldRequiredDescription
waba_idYesWhatsApp Business Account ID from Meta
phone_number_idYesPhone Number ID from Meta
phone_numberYesE.164 format phone number
number_onboarding_modeYesbring_your_own or embedded_signup
number_providerYesmeta_direct for BYON
access_tokenYesMeta System User access token
display_nameNoBusiness display name
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/channels/whatsapp" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"waba_id":"1911116896216319","phone_number_id":"974161339121558","phone_number":"+15551234567","number_onboarding_mode":"bring_your_own","number_provider":"meta_direct","access_token":"EAAx...","display_name":"My Business"}'

​
Embedded signup

POST https://api.vobiz.ai/v1/messaging/channels/whatsapp/embedded-signup
Complete channel creation after the Meta Embedded Signup OAuth flow. Pass the authorization code returned by Meta.
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/channels/whatsapp/embedded-signup" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"code":"AQB...","waba_id":"1911116896216319","phone_number_id":"974161339121558"}'

​
Update channel

PUT https://api.vobiz.ai/v1/messaging/channels/whatsapp/{channel_id}
Update an existing channel’s display name or refresh its Meta access token when the previous token expires.
cURL
curl -X PUT \
  "https://api.vobiz.ai/v1/messaging/channels/whatsapp/{channel_id}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"Updated Business Name","access_token":"EAAx_new..."}'

​
Delete channel

DELETE https://api.vobiz.ai/v1/messaging/channels/whatsapp/{channel_id}
Disconnect and remove a WhatsApp channel from Vobiz. Does not delete the WABA or phone number from Meta.
Deleting a channel stops all messaging for that number. Active conversations will be closed.
cURL
curl -X DELETE \
  "https://api.vobiz.ai/v1/messaging/channels/whatsapp/{channel_id}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"