List canned actions
Canned actions with ID, name and the categories they are defined for.
GET https://cotlet.dev/api/v1/happyfox/canned-actions
read
Lists the canned actions your agent user can use, from Automate >> Canned Actions. A canned action shows in the ticket editor only for categories it is defined for, so the list carries them. Pass canned_action_id to apply_canned_action.
Parameters
| Name | Type | Description |
|---|---|---|
| category_id integer | integer | Only canned actions defined for this category. |
Request
curl https://cotlet.dev/api/v1/happyfox/canned-actions \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("happyfox", "list_canned_actions")const result = await cotlet.call('happyfox', 'list_canned_actions');cotlet call happyfox list_canned_actionsExample response
{
"canned_actions": [
{
"canned_action_id": 31,
"name": "Password reset steps",
"categories": [
"Support"
]
},
{
"canned_action_id": 44,
"name": "Invoice copy",
"categories": [
"Billing"
]
}
]
}