CMS Web Services - v4.0.6532.13712 [cms-b]

<back to all web services

MessageDelete

Deletes (marks as forwarded) a specific email message identified by MessageId.

The following routes are available for this service:
POST,GET/message/delete
POST,GET/message/kill
MessageDelete Parameters:
NameParameterData TypeRequiredDescription
MessageIdbodystringYesThe ID of the message
CompleteDeletionbodyboolNoCompletely remove all traces of the message from the database (default: false)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /message/delete HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MessageId: String,
	CompleteDeletion: False,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}