Start a Chat

post

https://api.unipile.com/v2/{account_id}/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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

^acc_(.*)$

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

Body Params

text

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).

name

string

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

users_ids

array | string

required

Participant(s) of the chat. To start a 1to1 chat, pass a single user id as a string. To start a group, pass an array of user ids. Passing an array with a single user id will attempt to start a group with that user only.

attachments

array of objects

The list of attachments (uploaded files or a shared post or job) to be sent with the message.

attachments

specifics

object

Object containing provider-specific chat data.

Response

200Default Response