eBay Trading APIVersion 1279
 

ReviseMyMessagesFoldersRequestType ( AbstractRequestType )

This call can be used to add, remove, or rename a custom folder in My eBay Messages. Note that the Inbox and Sent folders cannot be removed or renamed in My eBay Messages.

A user can have up to 10 custom folders in My eBay Messages, and it is possible to add, remove, or rename up to 10 custom folders with one ReviseMyMessagesFolders call

Call that uses ReviseMyMessagesFoldersRequestType:

Fields

FolderID ( long ) [0..*]
The eBay-generated unique identifier for a custom folder in My eBay Messages. The FolderID value is required for the 'Rename' and 'Remove' operations, but not for the 'Display' (add) operation. FolderID values can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or the FolderID value for a My eBay Messages folder can be seen at the end of the browser's URL field when you navigate to that folder in My eBay Messages.

Note: If multiple folders will be renamed with one call, the user must pay close attention to the order of the FolderID and FolderName fields, as eBay will process these requests in order according to the placement of the the FolderID and FolderName fields. So, the existing folder identified by the first FolderID field in the request payload will get renamed to the folder name passed into the first FolderName field in the request payload, and so on.
See the Field Index to learn which calls use FolderID.

FolderName ( string ) [0..*]
The user-specified name of the My eBay Messages folder. The FolderName value is required for the 'Display' (add) and 'Rename' operations, but not for the 'Remove' operation. In a 'Display' (add) operation, the name passed into the FolderName field is the name of the new folder. In a 'Rename' operation, the name passed into the FolderName field will be the new name of the existing folder that is specified through the corresponding FolderID field.

FolderName values can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or the FolderName value for a My eBay Messages folder can be seen when you navigate to My eBay Messages.

Note: If multiple folders will be renamed with one call, the user must pay close attention to the order of the FolderID and FolderName fields, as eBay will process these requests in order according to the placement of the the FolderID and FolderName fields. So, the existing folder identified by the first FolderID field in the request payload will get renamed to the folder name passed into the first FolderName field in the request payload, and so on.
See the Field Index to learn which calls use FolderName.

This required field is used to indicate the type of operation to perform (add, remove, or rename a folder). See the enumeration descriptions below for more information on the usage, requirements, and limitations on each operation.
See the Field Index to learn which calls use Operation.