api:helpcenter:case:update
Table of Contents
API : HelpCenter Case Update
Introduction
Update an existing HelpCenterCase
Request
| URL | https://api.telecomx.dk/helpcenter/case/CONVERSATION_ID | ||
|---|---|---|---|
| Method | POST | ||
| Access Level | RESELLER OR ADMIN | ||
| Param | id | conversationId | |
| Body | state | ENUM | State of the case: 'HANDLING, 'UNHANDLED' or 'CLOSED' |
| phoneNumber | String | phone number of customer of case | |
| emailAddress | String | email address of customer | |
| actionNeeded | Boolean | true if supporters need to act on case, false if awaiting answer from customer. Can be set in UI | |
Query Example
POST https://api.telecomx.dk/helpcenter/case/321456987465sff?helpCenterId=123456789abcdefghijklmn
Request body example
{ state: 'HANDLING', phoneNumber: '+4512345678', emailAddress: 'example@example.dk', actionNeeded: true }
Response
| JSON object | ||
|---|---|---|
| success | Boolean | True on success |
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | id | Conversationid not found |
| 404 | case | Case not found |
| 422 | state | Invalid state. Use UNHANDLED, HANDLING or CLOSED. |
| 422 | phoneNumber | Invalid phone number |
| 422 | actionNeeded | Invalid action needed |
| 500 | internal_error | <Unspecified error> |
api/helpcenter/case/update.txt · Last modified: 2024/12/06 11:56 by Mikkel Meerwaldt Jørgensen