WhatsApp Business API
Canned responses API
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
/
messaging
/
canned-responses
Canned responses API
curl --request GET \
--url https://api.vobiz.ai/api/v1/messaging/canned-responses \
--header 'X-Auth-ID: <x-auth-id>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/messaging/canned-responses"
headers = {
"X-Auth-ID": "<x-auth-id>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/messaging/canned-responses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));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/messaging
Authentication: Every request requires X-Auth-ID: MA_XXXXXXXX and X-Auth-Token: <token> headers (a Bearer JWT is also accepted). Set Content-Type: application/json on requests with a body. Get your credentials from console.vobiz.ai.
string
required
Your Vobiz account ID, for example
MA_XXXXXXXX.Endpoints overview
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/messaging/canned-responses | List all canned responses |
POST | /api/v1/messaging/canned-responses | Create a canned response |
DELETE | /api/v1/messaging/canned-responses/{id} | Delete a canned response |
List canned responses
GET https://api.vobiz.ai/api/v1/messaging/canned-responses
cURL
curl -X GET \
"https://api.vobiz.ai/api/v1/messaging/canned-responses" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: {auth_token}"
200 OK
{
"items": [
{
"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"
},
{
"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"
}
],
"total": 2,
"page": 1,
"limit": 20,
"has_more": false
}
Create canned response
POST https://api.vobiz.ai/api/v1/messaging/canned-responses
shortcut is the trigger agents type in the inbox. The content is the full text inserted.
| Field | Required | Description |
|---|---|---|
shortcut | Yes | Trigger keyword (e.g. /greeting) |
content | Yes | Full text of the canned reply |
cURL
curl -X POST \
"https://api.vobiz.ai/api/v1/messaging/canned-responses" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: {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/messaging/canned-responses/{id}
204 No Content.
cURL
curl -X DELETE \
"https://api.vobiz.ai/api/v1/messaging/canned-responses/{id}" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: {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) |
Was this page helpful?
⌘I
Canned responses API
curl --request GET \
--url https://api.vobiz.ai/api/v1/messaging/canned-responses \
--header 'X-Auth-ID: <x-auth-id>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/messaging/canned-responses"
headers = {
"X-Auth-ID": "<x-auth-id>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/messaging/canned-responses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));