Skip to main content

​
Single chat

Use this when your CRM already knows which YoLead chat should be opened.
The iframe opens the chat page directly. Because showChatsList is not requested, chatId is required and the session is restricted to that chat.

​
Inbox

Use this when you want to show the YoLead chats list inside your product.
The iframe opens the chats list and lets the user navigate to chat pages.

​
Start an outbound chat

Use this with a read-write API key when the user should start a new conversation without an existing chatId.
The iframe opens the outbound message composer. After the message is sent successfully, the iframe posts a chat.created event to the parent window with the resulting chatId, then opens that chat. Requesting startOutboundChat with a read key returns 403. Starting the conversation also requires outbound chat initiation on the company’s current plan; otherwise the send action returns 403 with code 40352. Connected email mailboxes are available in the same composer. When an email channel is selected, the recipient must have an email identity. A subject can be supplied for a new email chat; replies in an existing chat retain the conversation’s previous subject.

​
Inbox with actions

Use this with a read-write API key when users should be able to perform actions from the iframe.
If the same request is made with a read API key, YoLead only grants showChatsList and showChatPage. Check the capabilities returned by POST /v1/embed/sessions to see the effective session permissions.

​
Single chat with actions

Use this when your product owns navigation and the iframe should only show one chat, but the user should be able to act inside that chat.