Skip to content
Developer

CustomerChatroomMessage

Chat and notifications11 EndpointsChat / CustomerChatroomMessage

Result of the poll of a ChatroomMessage

GET/api/cp/chat/chatroom_message/{identifier}/poll

Counts per answer, the own votes and, unless the poll is anonymous, who voted for what. Requires chatroom_polls_enabled (sonst 8618).

Path parameters

identifierrequiredstring

Responses

200Poll result

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42/poll \
  --header 'x-iw-jwt-token: <TOKEN>'

Vote in the poll of a ChatroomMessage

PUT/api/cp/chat/chatroom_message/{identifier}/poll

Body: options (list of answer keys); replaces the own votes, an empty list takes the vote back. Only one key unless the poll allows several answers. 8620 once the poll is closed.

Path parameters

identifierrequiredstring

Request body application/json

  • optionsarray<string>

Responses

200Poll result

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42/poll \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "options": [
    "string"
  ]
}
'

Vote in the poll of a ChatroomMessage

PATCH/api/cp/chat/chatroom_message/{identifier}/poll

Body: options (list of answer keys); replaces the own votes, an empty list takes the vote back. Only one key unless the poll allows several answers. 8620 once the poll is closed.

Path parameters

identifierrequiredstring

Request body application/json

  • optionsarray<string>

Responses

200Poll result

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42/poll \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "options": [
    "string"
  ]
}
'

Close the poll of a ChatroomMessage

PUT/api/cp/chat/chatroom_message/{identifier}/poll/close

The creator, room admins and the administration end a poll; afterwards nobody can vote.

Path parameters

identifierrequiredstring

Responses

200Poll result

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42/poll/close \
  --header 'x-iw-jwt-token: <TOKEN>'

Close the poll of a ChatroomMessage

PATCH/api/cp/chat/chatroom_message/{identifier}/poll/close

The creator, room admins and the administration end a poll; afterwards nobody can vote.

Path parameters

identifierrequiredstring

Responses

200Poll result

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42/poll/close \
  --header 'x-iw-jwt-token: <TOKEN>'

Returns a list of all ChatroomMessages

GET/api/cp/chat/chatroom_message

Query parameters

chatroomstring_LIST
participantstring_LIST, LOGGED_IN_LIST
deletedbooleanThis property is used to mark an entity as deleted / archived | _LIST
createdstring_LIST, LOGGED_IN_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Returns a list of all ChatroomMessagesarray<ChatroomMessage>

Show fields (8)
  • idinteger

    Primary key of the chat message. Internal ID.

  • message_textstring

    Text of the chat message.

  • attachmentsarray<Attachment2>

    Attachments of the chat message.

    Show fields (7)
    • idinteger

      Primary key of the attachment. Internal ID.

    • filenamestring

      Original file name.

    • filesizestring

      Size of the file in bytes.

    • mimetypestring

      MIME type of the file.

    • createdstring (date-time)

      Point in time the attachment was created.

    • googledownloadlinkstring

      Download link of the file in Google Drive.

    • virus_checkedboolean

      1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.

  • reactionsarray<ChatroomMessageReaction4>

    Reactions to the chat message.

    Show fields (4)
    • idinteger

      Primary key of the reaction. Internal ID.

    • emojistring

      Emoji of the reaction.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • completedboolean

    A flag to indicate if this message is completed

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "message_text": "Text",
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

Returns a single ChatroomMessage entry.

GET/api/cp/chat/chatroom_message/{identifier}

Path parameters

identifierrequiredstring

Responses

200Return single ChatroomMessageChatroomMessage

Show fields (8)
  • idinteger

    Primary key of the chat message. Internal ID.

  • message_textstring

    Text of the chat message.

  • attachmentsarray<Attachment2>

    Attachments of the chat message.

    Show fields (7)
    • idinteger

      Primary key of the attachment. Internal ID.

    • filenamestring

      Original file name.

    • filesizestring

      Size of the file in bytes.

    • mimetypestring

      MIME type of the file.

    • createdstring (date-time)

      Point in time the attachment was created.

    • googledownloadlinkstring

      Download link of the file in Google Drive.

    • virus_checkedboolean

      1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.

  • reactionsarray<ChatroomMessageReaction4>

    Reactions to the chat message.

    Show fields (4)
    • idinteger

      Primary key of the reaction. Internal ID.

    • emojistring

      Emoji of the reaction.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • completedboolean

    A flag to indicate if this message is completed

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Updates an existing ChatroomMessage entry.

PUT/api/cp/chat/chatroom_message/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataChatroomMessage
    Show fields (8)
    • idinteger

      Primary key of the chat message. Internal ID.

    • message_textstring

      Text of the chat message.

    • attachmentsarray<Attachment2>

      Attachments of the chat message.

    • reactionsarray<ChatroomMessageReaction4>

      Reactions to the chat message.

    • completedboolean

      A flag to indicate if this message is completed

    • edited_atstring (date-time)

      Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

Responses

200Update single ChatroomMessageChatroomMessage

Show fields (8)
  • idinteger

    Primary key of the chat message. Internal ID.

  • message_textstring

    Text of the chat message.

  • attachmentsarray<Attachment2>

    Attachments of the chat message.

    Show fields (7)
    • idinteger

      Primary key of the attachment. Internal ID.

    • filenamestring

      Original file name.

    • filesizestring

      Size of the file in bytes.

    • mimetypestring

      MIME type of the file.

    • createdstring (date-time)

      Point in time the attachment was created.

    • googledownloadlinkstring

      Download link of the file in Google Drive.

    • virus_checkedboolean

      1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.

  • reactionsarray<ChatroomMessageReaction4>

    Reactions to the chat message.

    Show fields (4)
    • idinteger

      Primary key of the reaction. Internal ID.

    • emojistring

      Emoji of the reaction.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • completedboolean

    A flag to indicate if this message is completed

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Updates an existing ChatroomMessage entry.

PATCH/api/cp/chat/chatroom_message/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataChatroomMessage
    Show fields (8)
    • idinteger

      Primary key of the chat message. Internal ID.

    • message_textstring

      Text of the chat message.

    • attachmentsarray<Attachment2>

      Attachments of the chat message.

    • reactionsarray<ChatroomMessageReaction4>

      Reactions to the chat message.

    • completedboolean

      A flag to indicate if this message is completed

    • edited_atstring (date-time)

      Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

Responses

200Update single ChatroomMessageChatroomMessage

Show fields (8)
  • idinteger

    Primary key of the chat message. Internal ID.

  • message_textstring

    Text of the chat message.

  • attachmentsarray<Attachment2>

    Attachments of the chat message.

    Show fields (7)
    • idinteger

      Primary key of the attachment. Internal ID.

    • filenamestring

      Original file name.

    • filesizestring

      Size of the file in bytes.

    • mimetypestring

      MIME type of the file.

    • createdstring (date-time)

      Point in time the attachment was created.

    • googledownloadlinkstring

      Download link of the file in Google Drive.

    • virus_checkedboolean

      1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.

  • reactionsarray<ChatroomMessageReaction4>

    Reactions to the chat message.

    Show fields (4)
    • idinteger

      Primary key of the reaction. Internal ID.

    • emojistring

      Emoji of the reaction.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • completedboolean

    A flag to indicate if this message is completed

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Add a new ChatroomMessage

POST/api/cp/chat/chatroom_message/{chatroomIdentifier}

Path parameters

chatroomIdentifierrequiredstring

Request body application/json

  • dataChatroomMessage
    Show fields (8)
    • idinteger

      Primary key of the chat message. Internal ID.

    • message_textstring

      Text of the chat message.

    • attachmentsarray<Attachment2>

      Attachments of the chat message.

    • reactionsarray<ChatroomMessageReaction4>

      Reactions to the chat message.

    • completedboolean

      A flag to indicate if this message is completed

    • edited_atstring (date-time)

      Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

Responses

200Add a new ChatroomMessageChatroomMessage

Show fields (8)
  • idinteger

    Primary key of the chat message. Internal ID.

  • message_textstring

    Text of the chat message.

  • attachmentsarray<Attachment2>

    Attachments of the chat message.

    Show fields (7)
    • idinteger

      Primary key of the attachment. Internal ID.

    • filenamestring

      Original file name.

    • filesizestring

      Size of the file in bytes.

    • mimetypestring

      MIME type of the file.

    • createdstring (date-time)

      Point in time the attachment was created.

    • googledownloadlinkstring

      Download link of the file in Google Drive.

    • virus_checkedboolean

      1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.

  • reactionsarray<ChatroomMessageReaction4>

    Reactions to the chat message.

    Show fields (4)
    • idinteger

      Primary key of the reaction. Internal ID.

    • emojistring

      Emoji of the reaction.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • completedboolean

    A flag to indicate if this message is completed

  • edited_atstring (date-time)

    Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/cp/chat/chatroom_message/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "message_text": "Text",
    "completed": true,
    "edited_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "message_text": "Text",
  "attachments": [
    {
      "id": 42,
      "filename": "string",
      "filesize": "string",
      "mimetype": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "googledownloadlink": "string",
      "virus_checked": true
    }
  ],
  "reactions": [
    {
      "id": 42,
      "emoji": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "completed": true,
  "edited_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}