On this page

8 endpoints.

MethodPathSummary
GET/api/communities/{communityId}/groups/{groupId}/messagesGet paginated messages for a group
POST/api/communities/{communityId}/groups/{groupId}/messagesSend a new message to a group
DELETE/api/communities/{communityId}/groups/{groupId}/messages/{messageId}Delete a message (soft delete)
PUT/api/communities/{communityId}/groups/{groupId}/messages/{messageId}Update (edit) a message
POST/api/communities/{communityId}/groups/{groupId}/messages/{messageId}/reactionsAdd an emoji reaction to a message
DELETE/api/communities/{communityId}/groups/{groupId}/messages/{messageId}/reactions/{emoji}Remove an emoji reaction from a message
POST/api/communities/{communityId}/groups/{groupId}/messages/{messageId}/readMark a message as read
GET/api/communities/{communityId}/groups/{groupId}/unread-countGet unread message count for current user in a group

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—
pagequerynointeger—
limitquerynointeger—
beforequerynostring (date-time)—
afterquerynostring (date-time)—
searchquerynostring—

Responses

StatusDescriptionBody
200Paginated list of messages—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—

Request body (required) — application/json

FieldTypeRequiredDescription
contentstringyes—
replyToIdstring (uuid)no—

Responses

StatusDescriptionBody
201Message sent successfully—
403User is restricted from messaging—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—
messageIdpathyesstring (uuid)—

Responses

StatusDescriptionBody
200Message deleted successfully—
403Not authorized—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—
messageIdpathyesstring (uuid)—

Request body (required) — application/json

FieldTypeRequiredDescription
contentstringyes—

Responses

StatusDescriptionBody
200Message updated successfully—
403Not authorized or user is restricted—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—
messageIdpathyesstring (uuid)—

Request body (required) — application/json

FieldTypeRequiredDescription
emojistringyes—

Responses

StatusDescriptionBody
200Reaction added successfully—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—
messageIdpathyesstring (uuid)—
emojipathyesstring—

Responses

StatusDescriptionBody
200Reaction removed successfully—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—
messageIdpathyesstring (uuid)—

Responses

StatusDescriptionBody
200Message marked as read—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
groupIdpathyesstring (uuid)—

Responses

StatusDescriptionBody
200Unread countobject