> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.voicebip.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.voicebip.com/_mcp/server.

# Send a WhatsApp template message

POST https://api.voicebip.com/v1/messages/template
Content-Type: application/json

Sends a pre-approved WhatsApp template message. Templates must be
approved by Meta before use. Use this to initiate conversations
outside the 24-hour window.

As with `POST /v1/messages`, the `status` field is `sent` (synchronous)
or `queued` when the send is accepted onto the carrier-safe priority lane
(paced within the sender's daily conversation cap). A `queued` template
is sent as soon as there is headroom; track delivery via `message.*`
webhooks.

Reference: https://docs.voicebip.com/api/messages/send-template

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.voicebip.com` (Production, default)
- `https://sandbox.voicebip.com` (Sandbox)

## Request

### Body (application/json)

This endpoint expects an object.

- `agent_id` (string, required)
- `from_number` (string, required)
- `to_number` (string, required)
- `template_name` (string, required)
- `language_code` (string, optional, default: en)
- `parameters` (list of string, optional)

## Response

### 200

Template message queued

- `message_id` (string, optional)
- `conversation_id` (string, optional)
- `agent_id` (string, optional)
- `channel` (enum, optional)
  - Allowed values: `sms`, `whatsapp`
- `direction` (enum, optional)
  - Allowed values: `inbound`, `outbound`
- `from_number` (string, optional)
- `to_number` (string, optional)
- `body` (string, optional)
- `status` (enum, optional)
  - Allowed values: `queued`, `sent`, `delivered`, `read`, `failed`
- `segments` (integer, optional) — Number of SMS segments the message was split into. Populated for SMS channel only; null for WhatsApp.
- `created_at` (datetime, optional)
- `is_sandbox` (boolean, optional) — True when the message was created with a pk_test_ (sandbox) API key. Omitted when false.

## Errors

### 400 Send Template Request Bad Request Error

Bad request

- `error_code` (enum, required)
  - Allowed values: `NOT_FOUND`, `ALREADY_EXISTS`, `INVALID_ARGUMENT`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RATE_LIMITED`, `INTERNAL`, `UNAVAILABLE`, `QUOTA_EXCEEDED`, `NUMBER_UNAVAILABLE`, `CALL_FAILED`, `MESSAGE_FAILED`, `WEBHOOK_FAILED`, `AI_PROVIDER_ERROR`, `CALL_WINDOW_RESTRICTED`, `INVALID_REQUEST`, `INVALID_PLAN`, `NO_OP`, `NO_ACTIVE_SUBSCRIPTION`, `WORKSPACE_NOT_FOUND`, `TIER_SWITCH_UNSUPPORTED`, `INSUFFICIENT_BALANCE`, `WORKSPACE_BLOCKED`, `TIER_SWITCH_TOO_FREQUENT`, `CHANNEL_MISMATCH`, `OPT_OUT_ENFORCED`, `UPSTREAM_ERROR`, `REQUEST_BODY_TOO_LARGE`, `INVALID_BODY`, `AI_ERROR`, `ADMIN_DISABLED`, `STORE_UNAVAILABLE`, `ADMIN_DB_UNAVAILABLE`, `MISSING_ACTOR`, `ACTOR_TOO_LONG`, `MISSING_FIELD`, `INVALID_JSON`, `INVALID_AMOUNT`, `INVALID_INCLUDED_QTY`, `INVALID_CURRENCY`, `INVALID_PROFILE`, `INVALID_RESOURCE`, `INVALID_UNIT`, `INVALID_TIER`, `INVALID_EFFECTIVE_FROM`, `NOTES_TOO_LONG`, `INVALID_LIMIT`, `LIST_FAILED`, `UPSERT_FAILED`, `WORKSPACE_OVERRIDE_DISABLED`, `WORKSPACE_OVERRIDE_UNCONFIRMED`, `MISSING_WORKSPACE_HEADER`, `INVALID_PASSWORD`, `INVALID_EMAIL`, `INVALID_CREDENTIALS`, `EMAIL_EXISTS`, `EMAIL_NOT_VERIFIED`, `WEAK_PASSWORD`, `MISSING_COMPANY`, `MISSING_TOKEN`, `INVALID_TOKEN`, `TOO_MANY_ATTEMPTS`
- `message` (string, required)
- `request_id` (string, required)
- `documentation_url` (string, optional)

## Examples

**Request**

```json
{
  "agent_id": "agent_id",
  "from_number": "from_number",
  "to_number": "to_number",
  "template_name": "template_name"
}
```

**Response**

```json
{
  "message_id": "message_id",
  "conversation_id": "conversation_id",
  "agent_id": "agent_id",
  "channel": "sms",
  "direction": "inbound",
  "from_number": "from_number",
  "to_number": "to_number",
  "body": "body",
  "status": "queued",
  "segments": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "is_sandbox": true
}
```

**SDK Code**

```python
import requests

url = "https://api.voicebip.com/v1/messages/template"

payload = {
    "agent_id": "agent_id",
    "from_number": "from_number",
    "to_number": "to_number",
    "template_name": "template_name"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.voicebip.com/v1/messages/template';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"agent_id":"agent_id","from_number":"from_number","to_number":"to_number","template_name":"template_name"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voicebip.com/v1/messages/template"

	payload := strings.NewReader("{\n  \"agent_id\": \"agent_id\",\n  \"from_number\": \"from_number\",\n  \"to_number\": \"to_number\",\n  \"template_name\": \"template_name\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.voicebip.com/v1/messages/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"agent_id\",\n  \"from_number\": \"from_number\",\n  \"to_number\": \"to_number\",\n  \"template_name\": \"template_name\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.voicebip.com/v1/messages/template")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"agent_id\",\n  \"from_number\": \"from_number\",\n  \"to_number\": \"to_number\",\n  \"template_name\": \"template_name\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.voicebip.com/v1/messages/template', [
  'body' => '{
  "agent_id": "agent_id",
  "from_number": "from_number",
  "to_number": "to_number",
  "template_name": "template_name"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.voicebip.com/v1/messages/template");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"agent_id\": \"agent_id\",\n  \"from_number\": \"from_number\",\n  \"to_number\": \"to_number\",\n  \"template_name\": \"template_name\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "agent_id": "agent_id",
  "from_number": "from_number",
  "to_number": "to_number",
  "template_name": "template_name"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.voicebip.com/v1/messages/template")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```