getConversation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a conversation by conversation ID.

If you don't have the conversation ID, use getOrCreateConversation() to retrieve the conversation using the visitor, contact, or member ID.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Inbox Messages
Read Inbox Messages
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
conversationIdstringRequired

Conversation ID.

Returns
Return Type:Promise<Conversation>
Was this helpful?
Yes
No