Skip to main content
POST
Start a conversation

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Body

application/json
recipients
object[]
required

The other people, each named by exactly one of member_id (another member of the company) or contact_id (one of the member's own contacts).

Required array length: 1 - 50 elements
title
string

A name, which makes a group even with one other member.

Required string length: 1 - 120

Response

The conversation that already exists with these people.

One conversation.

status
integer
required
data
object
required

One conversation as the signed-in member sees it.

meta
object
required

Envelope metadata present on every response.