Start a Chat from Inbox

post

https://api.unipile.com/v2/{account_id}/inboxes/{inbox_id}/chats/send

Starts a new 1to1 or group chat in the given inbox by sending the first message.
Use Send a Message if a conversation already exist with the wanted user(s).
Use Start a Chat instead if the provider does not use the inbox concept.

Multipart supported, refer to Sending Files.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

inbox_id

string

required

length ≥ 1

ID of the Inbox to start the Chat in. Use List all Inboxes to get the ID of an inbox.

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

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

200Default Response