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

Moves the given list of messages from their current folder to the selected destination folder

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

Post request body which has the destination folder name and the list of messages to be moved

MoveMessageSetting

Name	Description	Type	Additional information
DestinationFolderName	The folder to move the selected messages to	string	Required
MessageIds	A list of the messages to move	Collection of string	Required

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

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 'MoveMessageSetting'.

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.