API Reference
Create Unipile AccountDashboardWebsite
  1. Methods
  2. Messaging

Start a Chat

post
https://api.unipile.com/v2//chats/send

Starts a new 1to1 or group chat by sending the first message.
Use Send a Message if a conversation already exist with the wanted user(s).
Use Start a Chat from Inbox if the provider uses the inbox concept.

Multipart supported, refer to Sending Files.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Body Params
string
required

The textual content of the first message to be sent in the chat. It's recommended not to use HTML or Markdown. Use empty string to start a chat without a message (if supported by the provider).

string

A custom name for the chat. Some providers allow custom names only on groups. Default is made of participant names.

array | string
required

Participants of the chat.

attachments
array of objects

The list of file attachments to the message to be sent in the chat.

attachments
specifics
object

Object containing provider-specific chat data.

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?