Skip to main content

This type defines the request payload of the updateConversation method.

Types that use UpdateConversationRequest

Not used by any types.

Call that uses UpdateConversationRequest

POST
/update_conversation

Fields

Field
Type
Description
conversationId
string
This field specifies the unique identifier of the conversation that is to be updated.

Use the getConversations method to retrieve conversation ID values
conversationStatus
string
This field specifies the status for which to update the specified conversation.

Valid values:
  • ACTIVE
  • ARCHIVE
  • DELETE
Note: This field should not be used in conjunction with the read field. If both fields are input in the request, only the read status will be updated for the specified conversation and the conversationStatus field will be ignored.
conversationType
string
This field specifies the existing type of the conversation being updated.

Important! This value cannot be updated using this method, but is required as part of the request payload.


Valid values:
  • FROM_MEMBERS
  • FROM_EBAY
read
boolean
This boolean specifies the read status for which to update the conversation.

If set to true, the conversation will update to 'read', and if set to false, the conversation will update to 'unread'.

Note: This field should not be used in conjunction with the conversationStatus field. If both fields are input in the request, only the read status will be updated for the specified conversation and the conversationStatus field will be ignored.