WhatsApp Business API
WhatsApp Canned Responses API — Reply Shortcuts
Create and manage WhatsApp canned responses on Vobiz - reusable reply snippets that agents trigger with a /shortcut command directly inside the inbox.
GET
/
api
/
v1
/
Account
/
{auth_id}
/
WhatsApp
/
CannedResponse
/
List canned responses
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"id": "2b4d6f8a-0c1e-4a3b-9d5f-7e9a1c3b5d17",
"shortcut": "thanks",
"content": "Thanks for reaching out! We'll get back to you shortly.",
"created_at": "2026-10-12T08:00:00Z"
}
],
"total": 1,
"page": 1,
"limit": 100,
"has_more": false
}How agents use them: In the inbox, an agent types
/greeting and the pre-saved content is automatically inserted into the reply box.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 body. Get your credentials from console.vobiz.ai.
Endpoints overview
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/Account/{auth_id}/WhatsApp/CannedResponse/ | List all canned responses |
POST | /api/v1/Account/{auth_id}/WhatsApp/CannedResponse/ | Create a canned response |
DELETE | /api/v1/Account/{auth_id}/WhatsApp/CannedResponse/{id}/ | Delete a canned response |
List canned responses
GET https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/
page is always 1, limit is always 100, and has_more is always false. This request takes no path parameters and no request body.
cURL
curl -X GET \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/CannedResponse/" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
200 OK
{
"items": [
{
"id": "c4d5e6f7-0819-42a3-b4c5-d6e7f8091021",
"shortcut": "/hours",
"content": "Our support hours are Monday-Friday, 9am-6pm IST.",
"created_at": "2026-03-02T11:00:00Z"
},
{
"id": "b3c4d5e6-f708-4192-a3b4-c5d6e7f80910",
"shortcut": "/greeting",
"content": "Hello! Thank you for reaching out. How can I help you today?",
"created_at": "2026-03-01T10:00:00Z"
}
],
"total": 2,
"page": 1,
"limit": 100,
"has_more": false
}
Create canned response
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/
shortcut is the trigger agents type in the inbox, and it must be unique on your account. The content is the full text inserted. A missing field or a shortcut that already exists returns 400. Returns 201 Created.
| Field | Required | Description |
|---|---|---|
shortcut | Yes | Trigger keyword (e.g. /greeting). Must be unique on your account. |
content | Yes | Full text of the canned reply |
cURL
curl -X POST \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/CannedResponse/" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{"shortcut":"/greeting","content":"Hello! Thank you for reaching out. How can I help you today?"}'
201 Created
{
"id": "b3c4d5e6-f708-4192-a3b4-c5d6e7f80910",
"shortcut": "/greeting",
"content": "Hello! Thank you for reaching out. How can I help you today?",
"created_at": "2026-03-01T10:00:00Z"
}
Delete canned response
DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/{id}/
204 No Content, or 404 for an unknown canned response.
cURL
curl -X DELETE \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/CannedResponse/{id}/" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
204 No Content
// Empty body on success
Canned response object
| Field | Type | Description |
|---|---|---|
id | UUID | Canned response ID |
shortcut | string | Trigger keyword (e.g. /greeting) |
content | string | Full text inserted into the reply box |
created_at | RFC3339 | Creation timestamp (UTC) |
Authorizations
Path Parameters
Response
Your canned responses.
Was this page helpful?
⌘I
List canned responses
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/CannedResponse/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"id": "2b4d6f8a-0c1e-4a3b-9d5f-7e9a1c3b5d17",
"shortcut": "thanks",
"content": "Thanks for reaching out! We'll get back to you shortly.",
"created_at": "2026-10-12T08:00:00Z"
}
],
"total": 1,
"page": 1,
"limit": 100,
"has_more": false
}