Table of Contents

API : HelpCenter Case Update

Introduction

Update an existing HelpCenterCase. Only the fields present in the body are updated.

Request

URL https://api.telecomx.dk/helpcenter/case/CONVERSATION_ID
Method POST
Access level RESELLER_ADMIN with HELPCENTER feature, or ADMIN.
Param CONVERSATION_ID ConversationId of the case.
Body state String [optional] State of the case: UNHANDLED, HANDLING or CLOSED.
phoneNumber String [optional] Phone number of the customer on the case.
emailAddress String [optional] Email address of the customer on the case.
actionNeeded Boolean [optional] True if supporters need to act on the case, false if awaiting answer from the customer.

Query example

POST https://api.telecomx.dk/helpcenter/case/AAQkAGVjOTAxYzQ4LTk3M2E=

Request body example

{
  "state": "HANDLING",
  "phoneNumber": "+4512345678",
  "emailAddress": "jane@example.dk",
  "actionNeeded": true
}

Response

JSON object
success Boolean True on success

Example

{
  "success": true
}

Errors

Error code Message Description
404 case Case not found
422 state State is not valid. Use UNHANDLED, HANDLING or CLOSED.
422 phoneNumber Phone number is not valid
422 emailAddress Email address is not valid
422 actionNeeded Action needed is not valid
403 access_denied Insufficient access level
500 internal_error <Unspecified>