Skip to main content
GET
List 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/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

List canned responses

Returns all canned responses for your account, newest first. The list isn’t paginated: 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
200 OK

Create canned response

Create a new canned response. The 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.
cURL
201 Created

Delete canned response

Permanently delete a canned response. Agents can no longer insert it with its shortcut. Returns 204 No Content, or 404 for an unknown canned response.
cURL
204 No Content

Canned response object

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Path Parameters

auth_id
string
required

Your account Auth ID. It must match the X-Auth-ID header.

Example:

"MA_XXXXXXXX"

Response

Your canned responses.

items
object[]
required

All your canned responses, newest first.

total
integer
required

Number of canned responses.

Example:

1

page
integer
required

The page number. The list returns every canned response at once, so this is 1.

Example:

1

limit
integer
required

The page size, 100.

Example:

100

has_more
boolean
required

false, because the list returns every canned response at once.

Example:

false