POST api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/deleteMessages

Deletes the given list of messages

Request Information

URI Parameters

Name	Description	Type	Additional information
systemPhoneNumber	A system phone number on the app containing the messages	string	Required
mailboxNumber	A mailbox number on the app containing the messages	integer	Required

Body Parameters

It contains the Post request body which has the list of messages to be deleted

DeleteMessageSetting

Name	Description	Type	Additional information
MessageIds		Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "MessageIds": [
    "A1234569873",
    "I565456465"
  ]
}

application/xml, text/xml

Sample:

<DeleteMessageSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models.RequestDTOs">
  <MessageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>A1234569873</d2p1:string>
    <d2p1:string>I565456465</d2p1:string>
  </MessageIds>
</DeleteMessageSetting>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DeleteMessageSetting'.

Response Information

Resource Description

200 status code will be returned if all parameters are valid. 400 will be returned if any of the parameters are invalid. 402 status code will be returned if system number is on hold. 403 will be returned if the user does not have access to the account or mailbox specified.

None.