Get a Canned Response
- Print
- DarkLight
- PDF
Get a Canned Response
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/canned-responses/{_id}
Get a specific canned response.
Permission required: view-canned-responses
Changelog
| Version | Description |
|---|---|
| 1.0.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
_id
stringRequired
The canned response's ID.
ExampleEwmbZ9nLSx7kFamYB
Responses
200
OK
Success Example
{
"cannedResponse": {
"_id": "EwmbZ9nLSx7kFamYB",
"shortcut": "user",
"text": "Meu 32423423423423423",
"scope": "user",
"userId": "9L3wuBXKpbAWdfgx8",
"createdBy": {
"_id": "9L3wuBXKpbAWdfgx8",
"username": "rafael.ferreira"
},
"_createdAt": "2021-05-26T18:59:17.929Z",
"_updatedAt": "2021-05-26T18:59:17.929Z"
},
"success": true
}object
cannedResponse
object
_id
string
shortcut
string
text
string
scope
string
userId
string
createdBy
object
_id
string
username
string
_createdAt
string
_updatedAt
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?