Wix Answers Help Center
Saved Reply APIs
Saved replies are prewritten templates that can be easily added to an agent's reply. They provide an efficient tool for giving answers to repeat questions which overall saves you time and simplifies your workflow.
Each saved reply is specific to a locale.
By default, a saved reply is not shared, and is visible only to the agent that creates it. Therefore, we recommend that you use a user-specific authorization token when creating a non-shared reply, since you must use the same (or another) token for that user to view or edit the reply. Any agent can view or edit a shared saved reply.
Manage Saved Replies
Add a Saved Reply
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies
Add a saved reply. We recommend that you use a user-specific authorization token when creating a non-shared reply, since you must use the same (or another) token for that user to view or edit the reply.
Add a saved reply. We recommend that you use a user-specific authorization token when creating a non-shared reply, since you must use the same (or another) token for that user to view or edit the reply.
- Authorization: Requires agent authorization token for specific agent (specific agent not required, but see above). If shared is set to true in the payload, then permission MANAGE_SAVED_REPLIES is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Saved Reply object
Payload Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | ✓ |
shared | Whether the reply is shared Only you can view and manage a non-shared reply that you create. Any agent can view and manage a shared reply. Note: See above for permission requirement when set to true. | Boolean Default is false. | |
title | Saved reply title Once published, the title must be unique in your tenant. | String Default is an empty string. | ✓ Title is required once published. |
content | Saved reply content | String Default is an empty string. | ✓ Content is required once published. |
shortcut | The reply's hashtag shortcut, not including the hash (#) character The shortcut is maximum 25 characters and cannot include the characters "<" or ">". | String | |
status | Integer |
Payload Example:
1 2 3 4 5 6 7 8 9
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies { "locale": "en", "title": "Reply Title", "content": "Reply content here.", "shortcut": "reply", "status": 1 }
Get a Published Saved Reply
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}?locale={locale}
Get a published saved reply, either one of your own, or any shared saved reply. This endpoint does not return draft or deleted saved replies.
Get a published saved reply, either one of your own, or any shared saved reply. This endpoint does not return draft or deleted saved replies.
- Authorization: Requires agent authorization token for specific agent (specific agent required for non-shared saved reply) and permission FETCH_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Saved Reply object
Request Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | ✓ |
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920?locale=en
Get a Saved Reply
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}/admin?locale={locale}
Get a saved reply, either one of your own, or any shared saved reply. This endpoint also returns your own draft or deleted saved replies.
Get a saved reply, either one of your own, or any shared saved reply. This endpoint also returns your own draft or deleted saved replies.
- Authorization: Requires agent authorization token for specific agent (specific agent required for non-shared saved reply) and permission FETCH_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Saved Reply object
Request Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | ✓ |
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920/admin?locale=en
Update a Saved Reply
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}
Update a saved reply, either one of your own, or any shared saved reply. You cannot update a deleted saved reply. See Important Information about Updating Using the API.
Update a saved reply, either one of your own, or any shared saved reply. You cannot update a deleted saved reply. See Important Information about Updating Using the API.
- Authorization: Requires agent authorization token for specific agent (specific agent required for non-shared saved reply). If the reply is public, then permission MANAGE_SAVED_REPLIES is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Payload Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | ✓ |
title | Saved reply title | String | ✓ Title is required once published. |
content | Saved reply content | String | ✓ Content is required once published. |
shortcut | The reply's hashtag shortcut, not including the hash (#) character The shortcut is maximum 25 characters and cannot include the characters "<" or ">". | String | |
status | Integer | ✓ |
Payload Example:
1 2 3 4 5 6 7 8 9
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/d367738e-368e-41fe-9289-1a5cbbc3c239 { "locale": "en", "title": "Reply Title", "content": "Reply content here.", "shortcut": "reply", "status": 1 }
Share a Saved Reply
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}
Share a saved reply that you created. This changes the value of the saved reply's parameter share to true.
Share a saved reply that you created. This changes the value of the saved reply's parameter share to true.
- Authorization: Requires agent authorization token for specific agent and permission MANAGE_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
No payload is expected.
Delete a Saved Reply
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}?locale={locale}
Delete a saved reply, either one of your own, or any shared saved reply.
Delete a saved reply, either one of your own, or any shared saved reply.
- Authorization: Requires agent authorization token for specific agent. If the reply is public, then permission MANAGE_SAVED_REPLIES is also required.
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Request Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply Note: If you delete a saved reply for the locale that is defined as the default for your tenant, then this saved reply is deleted for all other locales, as well. | Language code string (for example: 'de') | ✓ |
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920?locale=en
Search for Published Saved Replies
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/search
Search for published saved replies that match the specified criteria. This endpoint returns your own matching shared replies, as well as matching shared replies, but does not return draft or deleted replies.
Search for published saved replies that match the specified criteria. This endpoint returns your own matching shared replies, as well as matching shared replies, but does not return draft or deleted replies.
- Authorization: Requires agent authorization token for specific agent (specific agent required to return non-shared saved replies) and permission FETCH_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Structure including list of Saved Reply objects
Payload Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | ✓ |
text | Filter by text in title or content | String | |
shared | Filter by whether the saved reply is shared | Boolean | |
spellcheck | When set to true, try resolve spelling mistakes | Boolean Default is true. | |
sortType | Sort type: * Creation date, ascending (10) * Creation date, descending (20) * Last update date, ascending (30) * Last update date, descending (40) * Text score (100): Relevant when text is not empty. | Integer If text is not empty, the default type is 100. Otherwise, the default type is 40. | |
page | Page of results to return | Integer Default is 1. | |
pageSize | Number of results on each page | Integer, between 1 and 100 Default is 10. |
Payload Example:
1 2 3 4 5 6 7 8 9
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/search { "locale": "en", "text": "thank you", "sortType": 100, "page": 1, "pageSize": 20 }
Response Example:
1 2 3 4 5 6 7 8 9
{ "items": [ List of @Saved Reply objects ], "itemsCount": 108, "page": 2, "numPages": 22, "previousPage": 1, "nextPage": 3, "pageSize": 5 }
Search for Saved Replies
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/search/admin
Search for saved replies that match the specified criteria. This endpoint returns your own matching shared replies, as well as matching shared replies, and also may return draft or deleted replies.
Search for saved replies that match the specified criteria. This endpoint returns your own matching shared replies, as well as matching shared replies, and also may return draft or deleted replies.
- Authorization: Requires agent authorization token for specific agent (specific agent required to return non-shared saved replies) and permission FETCH_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Structure including list of Saved Reply objects
The payload is the same as that for Search for Published Saved Replies, with the following additional parameters:
Payload Params | Description | Type | Required |
---|---|---|---|
statuses | List of Saved Reply Statuses | List of integers. Default list is [1] (published saved replies, only). | ✓ At least one status is required. |
Payload Example:
1 2 3 4 5 6 7 8 9 10
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/search/admin { "locale": "en", "statuses": [0,1], "text": "thank you", "sortType": 100, "page": 1, "pageSize": 20 }
Response Example:
1 2 3 4 5 6 7 8 9
{ "items": [ List of @Saved Reply objects ], "itemsCount": 108, "page": 2, "numPages": 22, "previousPage": 1, "nextPage": 3, "pageSize": 5 }
Get List of Published Saved Reply Shortcuts
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/shortcuts
Get list of published saved reply shortcuts, either of your own, or of any shared saved replies. The results are not sorted.
Get list of published saved reply shortcuts, either of your own, or of any shared saved replies. The results are not sorted.
- Authorization: Requires agent authorization token for specific agent (specific agent required to return shortcuts for non-shared saved replies) and permission FETCH_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Return structure, see below
Payload Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | ✓ |
page | Page of results | Integer Default is 1. | |
pageSize | Number of results on each page | Integer, between 1 and 2,000 Default is 2000. |
Payload Example:
1 2 3 4 5 6 7
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/shortcuts { "locale": "en", "page": 1, "pageSize": 20 }
Response Example:
A list of shortcuts in the following structure:
A list of shortcuts in the following structure:
Response Params | Description | Type |
---|---|---|
id | Saved result ID | |
shortcut | Shortcut text | String |
1 2 3 4 5 6 7 8 9 10 11 12
{ [ { "id": "e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a", "shortcut": "foo" } { "id": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "shortcut": "bar" } ] }
Manage Saved Reply Translation Tasks
Add a Translation Task for a Saved Reply
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}/translations
Add a saved reply translation task. The saved reply must be shared, published, in the primary locale, and not deleted.
Add a saved reply translation task. The saved reply must be shared, published, in the primary locale, and not deleted.
When you create a translation task for a locale, Wix Answers creates a blank saved reply for that locale with the title "{primary locale's title}-{locale}". For example, a task to convert "Try Again" into German creates a new reply with the title "Try Again-de". The new task is attached to the reply of that locale. Note: If a saved reply already exists for that locale, but it is deleted, the a task is not created and the reply is restored, instead.
- Authorization: Requires agent authorization token
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Payload Params | Description | Type | Required |
---|---|---|---|
locales | List of saved reply languages | List of language code string (for example: ['en','de']) | At least one locale is required |
priority | Integer | ||
noteText | Task note, if any | String |
Payload Example:
1 2 3 4 5 6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/d367738e-368e-41fe-9289-1a5cbbc3c239/translations { "locales": ["de"], "priority": 20 }
Get a Saved Reply's Translation Tasks
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}/translations?locale={locale}
Get a saved reply's translation tasks. The saved reply must be shared.
Get a saved reply's translation tasks. The saved reply must be shared.
- Authorization: Requires agent authorization token and permission FETCH_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Structure including list of ContentTask Objects
Request Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | ✓ |
page | Page of results | Integer Default is 1. | |
pageSize | Number of results on each page | Integer, between 1 and 20 Default is 20. |
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920/translations?locale=en&page=2&pageSize=10
Response Example:
1 2 3 4 5 6 7 8 9
{ "items": [ List of @ContentTask objects ], "itemsCount": 108, "page": 2, "numPages": 22, "previousPage": 1, "nextPage": 3, "pageSize": 5 }
Get a Translation Task for a Saved Reply
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}/translations/{task GUID}
Get a specific translation task for a saved reply. The saved reply must be shared.
Get a specific translation task for a saved reply. The saved reply must be shared.
- Authorization: Requires agent authorization token and permission FETCH_SAVED_REPLIES
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: ContentTask Object
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920/translations/d367738e-368e-41fe-9289-1a5cbbc3c239
Add a Translation Task Note for a Saved Reply
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}/translations/{task GUID}/notes
Add a note to a saved reply translation task. The saved reply must be shared.
Add a note to a saved reply translation task. The saved reply must be shared.
- Authorization: Requires agent authorization token
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Note Object
Payload Params | Description | Type | Required |
---|---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') | |
content | Task note | String | ✓ |
Payload Example:
1 2 3 4 5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/d367738e-368e-41fe-9289-1a5cbbc3c239/translations/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/notes { "content": "Task note content" }
Update a Translation Task Note for a Saved Reply
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}/translations/{task GUID}/notes/{note GUID}
Update a note to a saved reply translation task. The saved reply must be shared. See Important Information about Updating Using the API.
Update a note to a saved reply translation task. The saved reply must be shared. See Important Information about Updating Using the API.
- Authorization: Requires agent authorization token
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
The payload is the same as adding a note. See Add a Translation Task Note for a Saved Reply.
Delete a Translation Task Note for a Saved Reply
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/{saved reply GUID}/translations/{task GUID}/notes/{note GUID}?locale={locale}
Delete a note for a saved reply translation task. The saved reply must be shared.
Delete a note for a saved reply translation task. The saved reply must be shared.
- Authorization: Requires agent authorization token
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Request Params | Description | Type |
---|---|---|
locale | Language of the saved reply | Language code string (for example: 'de') |
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/savedReplies/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920/translations/d367738e-368e-41fe-9289-1a5cbbc3c239/notes/77bc8694-5ccf-436c-ab2b-543563a5f425
Was this article helpful?