Skip to main content
GET
List channels
Base URL: https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp Authentication: every request needs the X-Auth-ID: MA_XXXXXXXX and X-Auth-Token: YOUR_AUTH_TOKEN headers, and the {auth_id} in the path must be the account those credentials belong to. Send Content-Type: application/json on requests with a body. Get your credentials from console.vobiz.ai.

List WhatsApp channels

Returns every WhatsApp channel connected to your Vobiz account, newest first, in an items array. The list isn’t paginated.
cURL
200 OK

Create WhatsApp channel

Connect a WhatsApp Business number using your WABA credentials from Meta Business Manager. Each number can be connected once; a duplicate returns 400 with channel already exists. A bring_your_own channel starts with verification_status pending until you complete BYON verification. Returns 201 Created with the new channel.
string
required
WhatsApp Business Account ID from Meta Business Manager.
string
Meta’s phone number ID. Required unless number_onboarding_mode is buy_from_vobiz.
string
required
The business phone number in E.164 format (e.g. +14155550100).
string
required
How you are connecting the number: buy_from_vobiz, bring_your_own, or embedded_signup. Case-insensitive.
string
required
A Meta access token with WhatsApp Business permissions for this WABA. Vobiz stores it encrypted and never returns it.
string
Display name to store with the channel.
string
Free-form label for who provides the number, for example vobiz.
string
The id of the number order, when you bought the number through Create number order.
cURL
201 Created

Embedded signup

Complete channel creation after Meta’s Embedded Signup flow. Pass the authorization code returned by Meta. Vobiz exchanges the code for an access token, reads the number’s details from Meta, registers the number for the WhatsApp Cloud API, and subscribes to the WABA’s webhooks. To register a number you bought from Vobiz on the WABA instead, send number_provider set to vobiz with phone_number. Repeating the request for a number that is already connected returns the existing channel, so a retried submit is safe. Returns 201 Created.
string
required
The single-use authorization code returned by Meta’s Embedded Signup popup. Codes expire after about 10 minutes.
string
required
The WhatsApp Business Account ID returned by Embedded Signup.
string
Meta’s phone number ID returned by Embedded Signup. Required unless you are registering a Vobiz number (number_provider is vobiz and phone_number is set).
string
The Vobiz number to register on the WABA, in E.164 format. Used with number_provider set to vobiz.
string
Set to vobiz to register a number bought from Vobiz on the WABA instead of using a number already on it.
string
Accepted for compatibility. Vobiz sets the channel’s mode itself: buy_from_vobiz for a Vobiz number and embedded_signup otherwise.
string
The Meta partner solution ID used for Embedded Signup, when Vobiz gave you one.
cURL
201 Created
The phone number and display name come from Meta, so phone_number uses Meta’s formatting and can include spaces and hyphens.

Update channel

Update an existing channel’s display name, or replace its Meta access token, for example after you rotate it in Meta Business Manager. Send at least one field; omitted fields keep their current value. An unknown channel returns 400 with channel not found or update failed. Returns 200 OK with the updated channel.
string
A new Meta access token. It can’t be empty.
string
New display name.
cURL

Delete channel

Disconnect a WhatsApp channel from your Vobiz account. The number stays registered with Meta, and the WABA is unchanged. Returns 204 No Content, or 404 for an unknown channel.
Deleting a channel stops messaging for that number through Vobiz and deletes the channel’s templates, conversations, messages, campaigns, and call logs on Vobiz.
cURL

Channel object

string
Channel ID (UUID). Pass it as channel_id when you send messages, place calls, or create campaigns.
string
Your Vobiz account ID (MA_XXXXXXXX).
string
WhatsApp Business Account ID from Meta.
string
Meta’s phone number ID for this number. Empty for a buy_from_vobiz channel whose number is not yet registered with Meta.
string
The business phone number, as supplied when the channel was created, or as Meta formats it for Embedded Signup channels (which can include spaces and hyphens).
string
How the number was connected: buy_from_vobiz, bring_your_own, or embedded_signup.
string
Who provides the number, for example vobiz. Omitted when not set.
string
The number order this channel was created from. Omitted when there is none.
string
verified or pending. A channel is pending while bring_your_own verification is incomplete, or when a buy_from_vobiz channel was created without a phone_number_id.
string
The display name shown to customers. Omitted when empty.
string
Channel state. New channels are active.
string
Creation timestamp (RFC3339 UTC).
string
Last update timestamp (RFC3339 UTC).
The access_token is stored encrypted and is never returned in any API response.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Path Parameters

auth_id
string
required

Your account Auth ID. It must match the X-Auth-ID header.

Example:

"MA_XXXXXXXX"

Response

Your channels.

items
object[]
required

Your channels, newest first. Empty array when you have none.