Skip to main content
GET
List templates
Meta approval required - Templates must be approved by Meta before they can be sent. Newly created templates start with status pending; approval typically takes a few minutes to 24 hours. Sync templates to pick up Meta’s decision.
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. Set Content-Type: application/json on requests with a JSON body. Get your credentials from console.vobiz.ai. The {channelId} path parameter is the id (UUID) of the channel the templates belong to, as returned by the Channels API.
Template create and list are always scoped to a channel under /Channel/{channelId}/Template/.

Template categories

List templates

Returns the channel’s templates as Vobiz last saw them, sorted by name and language. The list isn’t paginated: it returns every template in one response. Run Sync templates first to pick up review results and templates created in Meta Business Manager. This request takes no request body.
cURL
200 OK

Create template

Submit a new template to Meta for review on the channel’s WABA. Vobiz saves it with status pending. The request body uses Meta’s component format. Use double-brace numbered placeholders like {{1}}, {{2}} for dynamic content in the BODY. If Meta rejects the template, the request returns 400 with Meta’s message. Returns 201 Created.

Request body

Each component object:
cURL
201 Created

Upload a header sample

For a template with an IMAGE, VIDEO, or DOCUMENT header, upload sample media first. Send multipart/form-data with a channel_id field and a file field (up to 16 MB). Put the returned handle in the header component’s example.header_handle array when you create the template.
cURL
200 OK

Sync templates from Meta

Pulls up to 250 templates and their current statuses from the channel’s WABA and saves them to your Vobiz account. Call this after creating templates in Meta Business Manager directly, or after Meta reviews a template (for example, when it moves from pending to approved). Returns the number of templates synced. This request takes no request body.
cURL
200 OK

Template object

Sending a template message

Creating a template does not send anything. To send an approved template, use the Messages API with type: "template".
cURL

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"

channelId
string<uuid>
required

The id (UUID) of the channel the templates belong to, as returned by GET /Channel/.

Query Parameters

status
string

Return only templates with this status. Statuses are lowercase, for example approved, pending or rejected.

Example:

"approved"

Response

The channel's templates.

items
object[]
required

Templates sorted by name, then language. Empty array when none match.

total
integer
required

Number of templates returned.

Example:

1

page
integer
required

The page number. The list returns every matching template at once, so this is 1.

Example:

1

limit
integer
required

The page size, 250.

Example:

250

has_more
boolean
required

false, because the list returns every matching template at once.

Example:

false