Canned Responses API

Manage saved reply shortcuts for your support agents. Canned responses are reusable message snippets triggered by a /shortcut in the inbox.

How agents use them: In the inbox, an agent types /greeting and the pre-saved content is automatically inserted into the reply box.

Overview

Method	Endpoint	Description
GET	https://api.vobiz.ai/v1/messaging/canned-responses	List all canned responses
POST	https://api.vobiz.ai/v1/messaging/canned-responses	Create a canned response
DELETE	https://api.vobiz.ai/v1/messaging/canned-responses/{id}	Delete a canned response

List Canned Responses

GEThttps://api.vobiz.ai/v1/messaging/canned-responses

Returns all saved canned responses for your account.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X GET \
  "https://api.vobiz.ai/v1/messaging/canned-responses" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

Response — 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

POSThttps://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 that gets inserted.

Field	Required	Description
shortcut	Required	Trigger keyword (e.g. /greeting)
content	Required	Full text of the canned reply

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

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

DELETEhttps://api.vobiz.ai/v1/messaging/canned-responses/{canned_response_id}

Permanently delete a canned response. Agents will no longer be able to trigger it by shortcut.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

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}"

Response — 204 No Content

// Empty body on success

Campaigns API

Calls API

Last updated: April 2026Edit this page