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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Inbox Messages
Learn more about app permissions.
Method Declaration
Copy
function getOrCreateConversation(
  participantId: ParticipantId,
): Promise<GetOrCreateConversationResponse>;
Method Parameters
participantIdParticipantIdRequired

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

Returns
Return Type:Promise<GetOrCreateConversationResponse>
JavaScript
import { conversations } from "@wix/inbox";

async function getOrCreateConversation(participantId) {
  const response = await conversations.getOrCreateConversation(participantId);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?