getOrCreateConversation( )


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 the specified visitor, contact, or member ID. If the conversation does not exist for the provided visitor, contact, or member, the function creates a new conversation.

Authentication

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

Permissions
Manage Inbox Messages
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
participantIdParticipantIdRequired

ID of the visitor, contact, or member chatting with the business.

Returns
Return Type:Promise<GetOrCreateConversationResponse>
Did this help?