create-a-canned-response.md

Create a Canned Response

Create a new canned response.

{% hint style="info" %} It requires the save-canned-responses and save-all-canned-responses permission. {% endhint %}

URL	Requires Auth	HTTP Method
/api/v1/canned-responses	yes	POST

Headers

Argument	Example	Required	Description
X-User-Id	myuser-name	Required	The authenticated user ID.
X-Auth-Token	myauth-token	Required	Auth token.

Payload

Argument	Example	Required	Description
shortcut	card-declined	Required	The shortcut to the message snippet.
text	reasons for your cardmalfunction	Required	The message snippet
scope	global	Required	The scope of the canned response. It can either be global, user or department.
tags	card	Optional	The tags for your canned response.
departmentId	64181a0728384134ed600dcc	Optional; required, only if the scope is department.	The departmentId where the canned response belongs to. It is required if the scope is department.

Example payload

{
    "shortcut": "test-canned",
    "text": "This is an example test for canned response",
    "scope": "global",
    "tags": ["tag1", "tag2"]
}

Example Call

curl --location 'http://localhost:3000/api/v1/canned-responses' \
--header 'X-User-Id: 2tTEqR7ZNMJ4HGGNa' \
--header 'X-Auth-Token: A6PF2Qa-wXunBXi3j77OBY-T-gl1BvJ11jYiSMt6Z_G' \
--header 'Content-Type: application/json' \
--data '{
    "shortcut": "test-canned",
    "text": "This is an example test for canned response",
    "scope": "global",
    "tags": ["tag1", "tag2"]
}'

Example Result

Success

{
  "success": true
}

Error

Any of the following errors can occur on the endpoint.

• Authorization: Requires an authentication token for the request to be made.
• No Permission: Occurs when the authenticated user doesn't have the save-canned-responses and save-all-canned-responses permission.
• Invalid Department: If the scope of the canned response is department, a valid departmentId is required to specify the department it belongs to. This error occurs when there is no valid departmentId in the body of the request.
• Shortcut Exists: The shortcut value of the canned response must be unique. This error occurs when the shortcut already exists.

{% tabs %} {% tab title="Authorization" %}

{
    "status": "error",
    "message": "You must be logged in to do this."
}

{% endtab %}

{% tab title="No Permission" %}

{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}

{% endtab %}

{% tab title="Invalid Department" %}

{
    "success": false,
    "error": "Invalid department [error-invalid-department]",
    "errorType": "error-invalid-department",
    "details": {
        "method": "saveCannedResponse"
    }
}

{% endtab %}

{% tab title="Shortcut Exists" %}

{
    "success": false,
    "error": "Shortcut provided already exists [error-invalid-shortcut]",
    "errorType": "error-invalid-shortcut",
    "details": {
        "method": "saveCannedResponse"
    }
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
1.0.0	Added