updateMembership API

There are instances where you may need fine-grained control over routing of inbound messages. In these instances, we offer the updateMember API that be accessed via standard RESTful API or via our JavaScript framework.

platform.api.conversations.updateMembership( { conversationId:store.conversation.id }, { list:[ {dest: "GONE", targetGroup: "*"}], includeSystemMessage:false } );

dest (Destination) can be one of:

  • GONE: remove the conversation from the inbox and active chats

  • INBOX: send the conversation to the inbox of the specified targetGroups

  • CHAT: send the conversation to Active Chats of the specified targetGroups.

The boolean includeSystemMessage indicates whether a message should be posted to the customer report indicating the updated membership.