Canned Actions

Read All Canned Actions

URL <base_uri> / <response_format> /canned_actions/
HTTP Method GET
Response Data List of canned actions

Data Structure

JSON

                    
    [
        {
            "assign_to": {
                "active": true,
                "categories": [
                    75,
                    70,
                    72
                ],
                "email": "john@example.com",
                "id": 6,
                "is_account_admin": false,
                "name": "John k",
                "permissions": [
                    "delete_tags",
                    "add_tags",
                    "manage_multibranding",
                    "manage_staff",
                    "manage_contacts",
                    "manage_templates",
                    "manage_kb",
                    "manage_smart_rules",
                    "email_reply",
                    "web_reply",
                    "edit_replies",
                    "delete_replies",
                    "delete_tickets",
                    "close_tickets",
                    "move_tickets",
                    "split_tickets",
                    "assign_tickets",
                    "set_due_date",
                    "manage_categories",
                    "manage_priorities",
                    "manage_statuses"
                ],
                "role": {
                    "id": 1,
                    "name": "Administrator"
                }
            },
            "available_to": [
                1,
                6,
                5,
                4
            ],
            "categories": [
                75
            ],
            "description": "All friedls",
            "html_reply": "Test",
            "id": 14,
            "name": "All fields",
            "priority_to": {
                "default": false,
                "id": 2,
                "name": "Very High",
                "order": 4
            },
            "reply": "Test",
            "status_to": {
                "behavior": "completed",
                "color": "666666",
                "default": false,
                "id": 5,
                "name": "Closed",
                "order": 7
            },
            "tags": "33,45",
            "time_spent": 334
        },
        {
            "assign_to": {
                "active": false,
                "categories": [
                    70,
                    72
                ],
                "email": "james@example.com",
                "id": 3,
                "is_account_admin": false,
                "name": "James Taylor",
                "permissions": [
                    "delete_tags",
                    "add_tags",
                    "manage_contacts",
                    "email_reply",
                    "web_reply",
                    "edit_replies",
                    "delete_replies",
                    "delete_tickets",
                    "close_tickets",
                    "move_tickets",
                    "split_tickets",
                    "assign_tickets",
                    "set_due_date"
                ],
                "role": {
                    "id": 6,
                    "name": "Support Agent"
                }
            },
            "available_to": [
                1,
                6
            ],
            "categories": [
                75,
                70
            ],
            "description": "",
            "html_reply": "Hi,
Thanks for your valuable feedback. The feature request you've recommended has been already place at high priority. We have already added it to our road map.

Thanks", "id": 15, "name": "Feature Request", "priority_to": { "default": true, "id": 1, "name": "Normal", "order": 2 }, "reply": "Hi,\r\nThanks for your valuable feedback. The feature request you've recommended has been already place at high priority. We have already added it to our road map. \r\n\r\nThanks", "status_to": { "behavior": "pending", "color": "999933", "default": false, "id": 3, "name": "On Hold", "order": 5 }, "tags": "Feature Request", "time_spent": 1 } ]

Read One Canned Action by ID

Retrieve details of a canned action using the ID.

URL <base_uri> / <response_format> /canned_action/<id>/
HTTP Method GET
Response Data Canned action

Data Structure

JSON

                    
    {
        "name": "Upgrade",
        "tags": "",
        "assign_to": null,
        "available_to": [
            1,
            6,
            5,
            4
        ],
        "time_spent": null,
        "priority_to": {
            "default": true,
            "id": 1,
            "name": "Normal",
            "order": 2
        },
        "reply": "",
        "status_to": {
            "name": "On Hold",
            "color": "999933",
            "order": 5,
            "default": false,
            "behavior": "pending",
            "id": 3
        },
        "html_reply": "",
        "id": 6,
        "categories": [
            75,
            70,
            72,
            73,
            74
        ],
        "description": ""
    }