|
CannedResponse
Email Canned Responses are strings of ready-made text that can be inserted by the user into emails.
Supported API Calls: List | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
Unique Identity of a CannedResponse. When adding a new CannedResponse the value must be 0. |
|
UserId |
integer |
ID of the object's parent internal user. |
|
Name |
string (100) |
Name of the CannedResponse, maximum length is 100, cannot be blank. |
|
Description |
string (100) |
Enter your desired reusable text. You can enter basic HMTL formatting tags if you wish your snippet to post into your email with bolding and italicizing formatting. Maximum length is 100 and cannot be blank. |
|
SortOrder |
integer |
Sorting order of the response. This can be null. |
List
Description
Returns a list of canned responses values.
URL
https://{company}.bluecamroo.com/api/CannedResponse/list
HTTP Method
GET
Parameters
Returns a list of existing casestatus objects in the requested format (e.g., JSON or XML)
Data Return
Returns a list of CannedResponse objects the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Add
Description
Adds the canned response to the list of canned responses.
URL
https://{company}.bluecamroo.com/api/CannedResponse/add
HTTP Method
POST
Parameters
A CannedResponse object
Data Return
Returns the CannedResponse in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Pass a canned response object to replace the specified Canned Response.
URL
https://{company}.bluecamroo.com/api/CannedResponse/update
HTTP Method
PUT
Parameters
A CannedResponse object
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified Canned Response. The Canned Response type to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/CannedResponse/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|