Create Message Channel
Creates a message channel. Required fields depend on membershipType: company channels need membershipEntityId or companyId; individual channels need membershipEntityId or clientId; group channels need memberIds.
Authorizations
Body
Message channel to create
MembershipType is the kind of channel to create.
company, individual, group "individual"
ClientID is the client id for an individual channel. Alternative to membershipEntityId.
"client_abc123"
CompanyID is the company id for a company channel, or to disambiguate a client that belongs to multiple companies.
"company_abc123"
MemberIds are the client user ids to include. Required for group channels.
MembershipEntityId is the company id (company channel) or client id (individual channel) the channel is scoped to.
"client_abc123"
Response
OK
ClientID is the id of the client associated with an individual channel.
"client_abc123"
CompanyID is the id of the company associated with the channel.
"company_abc123"
CreatedAt is the time the channel was created.
"2023-01-01T00:00:00Z"
ID is the unique identifier of the message channel.
"abc123"
LastMessage is the time the most recent message was sent in the channel.
"2023-01-03T00:00:00Z"
LastRead is the time the viewer last read the channel. Populated alongside UnreadCount; omitted otherwise.
"2023-01-02T12:00:00Z"
MemberIds are the user ids that belong to the channel.
MembershipEntityId is the id of the entity (company or client) the channel is scoped to.
"client_abc123"
MembershipType describes whether the channel is scoped to a company, a single client, or an ad-hoc group.
company, individual, group "individual"
Object is the resource type discriminator, always "messageChannel".
"messageChannel"
UnreadCount is the number of unread messages for the viewer. Populated by the /unread endpoint and by the list endpoint when includeUnread=true; omitted otherwise.
3
UpdatedAt is the time the channel was last updated.
"2023-01-02T00:00:00Z"