Start a new chat

Start a new conversation with one or more attendee. ⚠️ Interactive documentation does not work for Linkedin specific parameters (child parameters not correctly applied in snippet), the correct format is linkedin[inmail] = true, linkedin[api]...

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

An Unipile account id.

string

The message that will start the new conversation. With LinkedIn recruiter, a range of HTML tags can be used directly in the body of the message to enhance the presentation. The supported tags are <strong> for bold text, <em> for italic text, <a href="www.my-link.com"> for external links, <ul> for unordered lists, <ol> for ordered lists and <li> for list items. Tags can be nested into each other if necessary.

attachments
array of files
attachments
file

(Linkedin | WhatsApp) A file to send as voice message. WhatsApp: prefer .mp3 or .m4a. Linkedin: prefer .m4a. Instagram: use the attachment field and prefer .m4a. Telegram: use the attachment field.

file

(Linkedin) A file to send as video message. WhatsApp: use attachments field.

attendees_ids
array of strings
required
length ≥ 1

One or more attendee provider ID. For instagram, please use the 'provider_messaging_id'. For LinkedIn users, use a provider_id starting with: ACo for classic, ACw for Sales Navigator, AE for Recruiter. For LinkedIn company messaging, please use the 'messaging_id'. For WhatsApp, please use '[email protected]'.

attendees_ids*
string

An optional field to set the subject of the conversation.

linkedin

Extra fields for Linkedin products

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json