Skip to main content
GET
/
api
/
v1
/
messaging
/
canned-responses
Canned responses API
curl --request GET \
  --url https://api.vobiz.ai/api/v1/messaging/canned-responses
How agents use them: In the inbox, an agent types /greeting and the pre-saved content is automatically inserted into the reply box.
Base URL: 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.

​
Endpoints overview

MethodEndpointDescription
GET/api/v1/messaging/canned-responsesList all canned responses
POST/api/v1/messaging/canned-responsesCreate 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
Returns a paginated list of canned responses for your account.
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
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/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}
Permanently delete a canned response. Agents will no longer be able to trigger it via shortcut. Returns 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

FieldTypeDescription
idUUIDCanned response ID
shortcutstringTrigger keyword (e.g. /greeting)
contentstringFull text inserted into the reply box
created_atRFC3339Creation timestamp (UTC)