Sign in
Home  >>  Documentation  >>  REST API

Shortcuts

Posted on Mar 04, 2016 16:59

With this API call you can manage your Shortcuts.

 

JSON Format

 

Each Shortcut is represented as JSON object with the following properties:

Name Type Description
 Id  number  The shortcut's id
 Shortcut  string  The shortcut
 Message  string  The message

 

 

Get All Shortcuts

 

GET /api/shortcuts

Get all shortcuts for your account.

 

Example response

[

    {

        "Id": 1,

        "Shortcut": "hi",

        "Message": "Hi there, how can I help you?"

    },

    {

        "Id": 2,

        "Shortcut": "welcome",

        "Message": "You're welcome"

    },

]

 

 

Get Shortcut by Id

 

GET /api/shortcuts/{shortcut_id}

Get a shortcut from your account by specified id.

 

Example response

{

    "Id": 1,

    "Shortcut": "hi",

    "Message": "Hi there, how can I help you?"

}

 

 

Create Shortcut

 

POST /api/shortcuts

Create a shortcut for your account.

 

Example response

{

    "Id": 3,

    "Shortcut": "questions",

    "Message": "If you have more questions please don't hesitate to contact us."

}

 

 

Update Shortcut

 

PUT /api/shortcuts/{shortcut_id}

Update a shortcut from your account by specified id.

 

Example response

{

    "Id": 1,

    "Shortcut": "hi",

    "Message": "Hi there :)"

}

 

 

Delete Shortcut

 

DELETE /api/shortcuts/{shortcut_id}

Delete a shortcut from your account by specified id.