api:helpcenter:case:reply
Table of Contents
API : HelpCenter Case Reply
Introduction
Sends a reply to an email via HelpCenter. The email is queued for sending, and the reply is added to the case as an OUTGOING message.
Request
| URL | https://api.telecomx.dk/helpcenter/case/CONVERSATION_ID/reply | ||
|---|---|---|---|
| Method | POST | ||
| Access level | RESELLER_ADMIN with HELPCENTER feature, or ADMIN. | ||
| Param | CONVERSATION_ID | ConversationId of the case the reply shall be attached to. | |
| Body | emailReply | String | Message to send by email. HTML is allowed (it is sanitized), max 50000 characters. |
| actionNeeded | Boolean | Sets if action is needed by supporters on the case. Required. | |
Request body example
{ "emailReply": "Hi, thank you for your email. We will get back to you shortly.", "actionNeeded": true }
Response
| JSON object | ||
|---|---|---|
| success | Boolean | True on success |
Response example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | emailReply | Email reply cannot be empty |
| 422 | emailReply | Email reply is too long |
| 422 | actionNeeded | Invalid action needed |
| 404 | conversationId | Case not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/helpcenter/case/reply.txt · Last modified: by Mikkel Meerwaldt Jørgensen