ReviseMyMessagesFolders

Use this call to add, rename, or remove a 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, so if a user has no custom folders defined for the account, one ReviseMyMessagesFolders call can be used to create up to 10 new custom folders. Similarly, if a user has 10 custom folders (with no messages in these folders), but they wanted to delete all 10 of these custom folders, one ReviseMyMessagesFolders call can be used to delete up to 10 custom (empty) folders.

Up to 10 custom folders in My eBay Messages can be renamed with one ReviseMyMessagesFolders call, but 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.

If the call is successful, an ack value of Success is returned, but no other call-specific data. If the call fails, or is only partially successful, one or more Errors container are returned to help the user troubleshoot the issue.

You can test this call in the Sandbox environment.

See also the reference documentation for this call:

• GetMyMessages - Retrieves information about the messages sent to a user.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<ReviseMyMessagesFoldersRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <FolderID> long </FolderID>
  <!-- ... more FolderID values allowed here ... -->
  <FolderName> string </FolderName>
  <!-- ... more FolderName values allowed here ... -->
  <Operation> MyMessagesFolderOperationCodeType </Operation>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</ReviseMyMessagesFoldersRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<ReviseMyMessagesFoldersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Output fields) -->

  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</ReviseMyMessagesFoldersResponse>

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Available samples:

• Basic Call ↓ - Creates a new My Messages folder.
• Renames a custom folder. ↓ - Renames a folder that you have previously created.

Creates a new My Messages folder.

Description

Seller m***************r sells several types of items, and she wants to organize the incoming messages from potential buyers. This call creates a new, custom My Messages folder titled "Classified."

Input

To create a new folder, set Operation to Display and use Foldername to specify the name of your new folder.

Note that new folders cannot be given the names "Inbox" or "Sent".

XML format.

<?xml version="1.0" encoding="utf-8"?>
<ReviseMyMessagesFoldersRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel>
  <Operation>Display</Operation> 
  <FolderName>C********d</FolderName> 
</ReviseMyMessagesFoldersRequest>

Output

XML format.
<ReviseMyMessagesFoldersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-06T22:12:51.723Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_API6_19105226_R1</Build>
</ReviseMyMessagesFoldersResponse>

Back to list of samples

Renames a folder that you have previously created.

Description

Seller m***************r created a folder titled "Classified", but she thinks that "ClassifiedAds" will better describe the folder name.

Input

To reanme a custom folder, set Operation to Rename and specify the new name in the Foldername field. You also need to supply the FolderID, which you obtain with a call to GetMyMessages. In the call to GetMyMessages, set DetailLevel to ReturnSummary to obtain your folder IDs.

Note that you cannot rename the "Inbox" or "Sent" folders.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<ReviseMyMessagesFoldersRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel>
  <Operation>Rename</Operation>
  <FolderID>1**6</FolderID>
  <FolderName>C***********s</FolderName> 
</ReviseMyMessagesFoldersRequest>

Output

XML format.
<ReviseMyMessagesFoldersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-06T22:12:51.723Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_API6_19105226_R1</Build>
</ReviseMyMessagesFoldersResponse>

Back to list of samples

Change History