Canned Responses

Canned responses are reusable reply templates that help your team respond to conversations quickly and consistently. Use these endpoints to list, retrieve, and create canned responses.

List Canned Responses

Retrieve all canned responses for the account.

Parameters

Parameter	Type	Required	Description
q	String	No	Search term to filter by name.
_page	Integer	No	Page number for pagination.
_count	Integer	No	Number of results per page.
_order	String	No	Sort field and direction, e.g. `created,0` for descending by creation date.

Example Request

curl -i https://api.oktopost.com/v2/canned-response

Example Result

{
	"Result": true,
	"Items": [
		{
			"ID": "cnr000000000001",
			"Name": "Welcome Reply",
			"Content": "Thanks for reaching out! How can we help you today?",
			"Visibility": "shared",
			"Created": "2025-01-15 08:30:00",
			"CreatedBy": {
				"Id": "00A000000000001",
				"Name": "Jane Smith",
				"Email": "jane@example.com"
			}
		},
		{
			"ID": "cnr000000000002",
			"Name": "Follow-up",
			"Content": "Just checking in — were we able to resolve your question?",
			"Visibility": "private",
			"Created": "2025-02-20 14:00:00",
			"CreatedBy": {
				"Id": "00A000000000001",
				"Name": "Jane Smith",
				"Email": "jane@example.com"
			}
		}
	],
	"Total": 2
}

Get Canned Response

Retrieve a single canned response by ID.

Example Request

curl -i https://api.oktopost.com/v2/canned-response/cnr000000000001

Example Result

{
	"Result": true,
	"CannedResponse": {
		"ID": "cnr000000000001",
		"Name": "Welcome Reply",
		"Content": "Thanks for reaching out! How can we help you today?",
		"Visibility": "shared",
		"Created": "2025-01-15 08:30:00",
		"CreatedBy": {
			"Id": "00A000000000001",
			"Name": "Jane Smith",
			"Email": "jane@example.com"
		}
	}
}

Create Canned Response

Create a new canned response.

Parameters

Parameter	Type	Required	Description
name	String	Yes	The display name (max 64 characters). Must be unique.
content	String	Yes	The response body text (max 10,000 characters).
visibility	String	No	Who can see this response. Accepted values: `shared` (default), `private`

Example Request

curl -i https://api.oktopost.com/v2/canned-response -X POST \
	-d name="Pricing Inquiry" \
	-d content="Thanks for your interest! I'd be happy to walk you through our plans." \
	-d visibility="shared"

Example Result

{
	"Result": true,
	"CannedResponse": {
		"ID": "cnr000000000003",
		"Name": "Pricing Inquiry",
		"Content": "Thanks for your interest! I'd be happy to walk you through our plans.",
		"Visibility": "shared",
		"Created": "2025-03-30 11:00:00",
		"CreatedBy": {
			"Id": "00A000000000001",
			"Name": "Jane Smith",
			"Email": "jane@example.com"
		}
	}
}

A 409 response is returned if a canned response with the same name already exists.

On this page