Skip to main content
GET
/
v1
/
messaging
/
canned-responses
Canned responses API
curl --request GET \
  --url https://api.example.com/v1/messaging/canned-responses

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

How agents use them: In the inbox, an agent types /greeting and the pre-saved content is automatically inserted into the reply box.
Authentication: X-Auth-ID, X-Auth-Token, Accept: application/json

​
Endpoints overview

MethodEndpointDescription
GET/v1/messaging/canned-responsesList all canned responses
POST/v1/messaging/canned-responsesCreate a canned response
DELETE/v1/messaging/canned-responses/{id}Delete a canned response

​
List canned responses

GET https://api.vobiz.ai/v1/messaging/canned-responses
Returns all saved canned responses for your account.
cURL
curl -X GET \
  "https://api.vobiz.ai/v1/messaging/canned-responses" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"
200 OK
{
  "data": [
    {"id":"cr_001","shortcut":"/greeting","content":"Hello! Thank you for reaching out. How can I help you today?","created_at":"2026-03-01T10:00:00Z"},
    {"id":"cr_002","shortcut":"/hours","content":"Our support hours are Monday–Friday, 9am–6pm IST.","created_at":"2026-03-02T11:00:00Z"}
  ]
}

​
Create canned response

POST https://api.vobiz.ai/v1/messaging/canned-responses
Create a new canned response. The shortcut is the trigger agents type in the inbox. The content is the full text inserted.
FieldRequiredDescription
shortcutYesTrigger keyword (e.g. /greeting)
contentYesFull text of the canned reply
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/canned-responses" \
  -H "X-Auth-ID: {auth_id}" \
  -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?"}'

​
Delete canned response

DELETE https://api.vobiz.ai/v1/messaging/canned-responses/{canned_response_id}
Permanently delete a canned response. Agents will no longer be able to trigger it via shortcut.
cURL
curl -X DELETE \
  "https://api.vobiz.ai/v1/messaging/canned-responses/{canned_response_id}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"
204 No Content
// Empty body on success