v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create Message Channel

This API endpoint creates a new message channel. See the Message Channel resource for detailed descriptions of the properties.

post/v1/message-channels

Request body

membershipTypestring required

The type of membership that this channel is associated with. Can be one of individual, group or company.

membershipEntityIdstring

Deprecated. Use clientId and companyId instead.

memberIdsstring[]

The ids of the clients to be added to this particular channel. Required for group channels. Ignored for individual and company channels.

clientIdstring

The id of the client this channel is for. Required for individual channels.

companyIdstring

The id of the company this channel belongs to. Required for company channels and when the client(s) members have multiple companies.

Response

200

idstring

objectstring

createdAtstring

updatedAtstring

membershipTypestring

clientIdstring

companyIdstring

membershipEntityIdstring

memberIdsstring[]

{"stackTrail":"paths:/v1/message-channels:post:responses:200:content:application/json:schema:properties:lastMessageDate","oasType":"schema","type":"unknown"}

Example response

{
  "id": "09660260-1e80-40a2-999c-d2255a33aff1",
  "object": "messageChannel",
  "createdAt": "2023-07-14T19:34:58.199614Z",
  "updatedAt": "2023-07-14T19:34:58.199614Z",
  "membershipType": "company",
  "clientId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "companyId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "membershipEntityId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "memberIds": [
    "638f3dc4-0a9c-4585-9b74-60bcdca1b30a"
  ]
}