POST (Header:DELETE) api.ashx/v2/conversations/{id}.{json|xml}
DELETE a conversation by id.
Scopes
Conversations › Modify Conversations conversations.conversations.modify
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Id | string | Id | Required | |||
Method | string | Deletion method. Options are 'Hide' or 'Leave'. Hide will hide the conversation until a new message is received. Leave will hide the conversation and will not restore it unless a remaining participant specifically requests that the removed participant return which will revalidate conversation access with the user. When all participants hide or leave the conversation, the conversation will be fully deleted. Default: Hide. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.del({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/conversations/{id}.json', data: { 'id': 'id' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> </Response>