1-877-548-3001 Sign in About Contact
Developer

GET

/api/canned_sets

Obtain a list of available canned sets

Scope:

operator

Response

Schema

{}

payload

The canned sets data

{}

canned_sets

The list of canned sets

[]

{}

enabled

True if the canned set is enabled else false

2

id

The id for the canned sets

A

name

The name of the canned set

2

order

The order of the canned set

2

parent_id

The id for the canned set parent folder (will be 0 for top level)

A

status

The system response status. Will be ok or error

curl

example request

1

curl -H "Authorization: Bearer {{Oauth Token}}"

2

https://developer.livehelpnow.net/api/canned_sets

example response

      
        
          1 {
        
        
          2   "payload":{
        
        
          3     "canned_sets":[{
        
        
          4       "enabled": true,
        
        
          5       "id": 123456,
        
        
          6       "name": "Test Folder",
        
        
          7       "order": 1,
        
        
          8       "parent_id": 0
        
        
          9     }],
        
        
          10  },
        
        
          11  "status": "ok"
        
        
          12 }