eBay Trading APIVersion 1173
MyMessagesFolderOperationCodeType ( token )
This enumerated type contains the operations that can be used in a ReviseMyMessagesFolders call.
Type that uses MyMessagesFolderOperationCodeType:
Call that uses one or more values of MyMessagesFolderOperationCodeType:
||Reserved for future or internal use.
||This enumeration value is used to create one or more custom folders in My eBay Messages. For a 'Display' operation, the new folder name(s) are specified in one or more FolderName fields. The maximum length of a folder name is 15 characters. Up to 10 new folders can be created with one ReviseMyMessagesFolders call, but this is also limited by how many custom folders exist at the time of the call, as only a maximum of 10 custom folders are supported in My eBay Messages.
||This enumeration value is used to remove one or more custom folders in My eBay Messages. For a 'Remove' operation, the folder(s) to remove are specified in one or more FolderID fields. The FolderID values for a My eBay Messages folders can be retrieved by calling GetMyMessages with a DetailLevel value set to
ReturnSummary, or these folder IDs can be found by navigating to a specific folder in My eBay Messages, and the ID value for the opened folder is displayed at the end of the browser's URL.
A My eBay Messages folder must be empty before being removed, and an error is returned if a user tries to remove a non-empty folder.
The Inbox and Sent folders cannot be removed under any circumstance.
||This enumeration value is used to rename one or more existing folders in My eBay Messages. For a 'Rename' operation, the unique identifier(s) of the message folder(s) to rename are specified in one or more FolderID fields, and the new name for the folder(s) are specified in one or more FolderName fields.
The FolderID and FolderName values can be retrieved by calling GetMyMessages with a DetailLevel value set to
ReturnSummary, or these folder names and identifiers can be found by navigating to My eBay Messages (Folder ID values are displayed at the end of the browser's URL when that folder is opened).
The maximum length of a folder name is 15 characters. The Inbox and Sent folders cannot be renamed.
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 Enumeration Index
to see exact use of each enumeration value in the API.
Copyright © 2005–2020
eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.