POST/bulk_update_conversation
This method can be used to update the conversationStatus of up to 10 conversations.
The conversationId, existing conversationType, and updated conversationStatus for each conversation to modify are required in the conversations array.
Important! Though it cannot be updated, the conversationType field is required for each conversation being updated.
If the updates were successful, the conversationId of each conversation will be returned with an associated updateStatus value of
SUCCESSFUL.Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/commerce.message
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| conversations | array of BulkConversation | This array specifies the list of conversations to update and the updated conversationStatus for each. Occurrence: Required |
| conversations.conversationId | string | This field indicates the unique identifier of the conversation that is to be updated. Occurrence: Required |
| conversations.conversationStatus | string | This field indicates the status for which to update the associated conversation.
Occurrence: Required |
| conversations.conversationType | string | This field specifies the existing type of the conversation that is to be updated. Important! This value cannot be updated using this method, but is required for each conversation being updated. Valid values:
Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| conversationsMetadata | ConversationsMetadata | This container returns metadata from the call, such as how many conversations were updated, how many succeeded, and how many failed. Occurrence: Always |
| conversationsMetadata.totalConversationsCount | integer | The total amount of conversations being updated. Occurrence: Always |
| conversationsMetadata.updateFailureCount | integer | The number of conversations in which the specified update failed. Occurrence: Always |
| conversationsMetadata.updateSuccessCount | integer | The number of conversations in which the specified update succeeded. Occurrence: Always |
| conversationsResponse | array of ConversationsResponse | This array returns a list of each conversation specified in the request, and if the requested update was successful or failed. Occurrence: Always |
| conversationsResponse.conversationId | string | The unique identifier of the conversation. Occurrence: Always |
| conversationsResponse.updateStatus | string | The update status of the conversation, such as Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 335000 | API_MESSAGE | APPLICATION | Internal server error encountered. If this problem persists, contact the eBay Developers Program for support. |
| 355001 | API_MESSAGE | REQUEST | Invalid conversationStatus value. Please see documentation for valid values. |
| 355002 | API_MESSAGE | REQUEST | Invalid conversationType value. Please see documentation for valid values. |
| 355007 | API_MESSAGE | REQUEST | Invalid or unrecognized conversation_id value. |
| 355019 | API_MESSAGE | REQUEST | The number of conversations for batch update exceeds the limit, a maximum of {maximumConversationAllowedCount} conversations is allowed per request. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Modify the statuses of conversations in bulk
This method can be used to update the status of up to 10 conversations.
Input
The conversationId, existing conversationType, and updated conversationStatus for each conversation to update are required in the conversations array.
In this sample, the statuses of three conversations are being updated.
POSThttps://api.ebay.com/commerce/message/v1/bulk_update_conversation
Output
If the call is successful, a response payload detailing the results of the call is returned.
As seen in this sample, the conversationsResponse array is returned, listing each conversation by ID and if the update was successful or failed (updateStatus). In addition, the conversationsMetadata container details the total amount of conversations that were updated (totalConversationsCount), as well as how many were successful (updateSuccessCount) and how many failed (UpdateFailureCount).