Send System Chat Message
POST /obp/v7.0.0/chat-rooms/CHAT_ROOM_ID/messages
OBPv6.0.0-sendSystemChatMessage No role required Chat
Send a message in a system-level chat room. The current user must be a participant and the room must not be archived.
Authentication is Required
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CHAT_ROOM_ID: CHAT_ROOM_ID
JSON request body fields (2)
- content
- content
- message_type
- message_type
JSON response body fields (16)
- chat_message_id
- chat_message_id
- chat_room_id
- chat_room_id
- content
- content
- created_at
- created_at
- is_deleted
- is_deleted
- mentioned_user_ids
- mentioned_user_ids
- message_type
- message_type
- reactions
- reactions
- reply_to_message_id
- reply_to_message_id
- sender_consumer_id
- sender_consumer_id
- sender_consumer_name
- sender_consumer_name
- sender_provider
- sender_provider
- sender_user_id
- sender_user_id
- sender_username
- sender_username
- thread_id
- thread_id
- updated_at
- updated_at
Example request body
{
"content": "Hello everyone!",
"message_type": "text"
}Example success response
{
"chat_message_id": "msg-id-123",
"chat_room_id": "chat-room-id-123",
"sender_user_id": "user-id-123",
"sender_consumer_id": "",
"sender_username": "robert.x.0.gh",
"sender_provider": "https://github.com",
"sender_consumer_name": "My Banking App",
"content": "Hello everyone!",
"message_type": "text",
"mentioned_user_ids": [],
"reply_to_message_id": "",
"thread_id": "",
"is_deleted": false,
"created_at": "2026-10-21T01:45:41Z",
"updated_at": "2026-10-21T01:45:41Z",
"reactions": []
}Possible errors (6)
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-39001: Chat Room not found. Please specify a valid value for CHAT_ROOM_ID.
- OBP-39004: Current user is not a participant of this Chat Room.
- OBP-39003: Chat Room is archived. No new messages or participants can be added.
- OBP-50000: Unknown Error.