Mark as Read Conversation REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:45:21 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:45:21

POST (Header:PUT) api.ashx/v2/conversations/{id}/read.{json|xml}

Request Parameters

Name	Type	Location	Description	Required	Default	Options
HasRead	bool	Request Body	New read state of the conversation	Required
id	Guid	Path	Id of the conversation	Required

Example Requests

Widget Javascript

jQuery.telligent.evolution.put({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/conversations/{id}/read.json',
	data: { 
		'id': '49fec544-6df7-4a82-872b-f8be586d5e9e',
		'HasRead': 'True'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "HasRead": true,
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <HasRead>true</HasRead>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>