User Message

the user message API

mark messages as seen

put

Path parameters

idinteger · int64Required

Query parameters

lastReadstring · date-timeRequired

Responses

200

OK

No content

put

/cmn/users/{id}/messages/last_read

HTTPcURLJavaScriptPython

PUT /api/cmn/users/{id}/messages/last_read?lastRead=2026-02-10T14%3A20%3A24.097Z HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

mark current user messages as seen

put

Query parameters

lastReadstring · date-timeRequired

Responses

200

OK

No content

put

/cmn/users/my/messages/last_read

HTTPcURLJavaScriptPython

PUT /api/cmn/users/my/messages/last_read?lastRead=2026-02-10T14%3A20%3A24.097Z HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

update a message

put

Path parameters

idinteger · int64Required

Body

application/json

localizeable message

messageCodestringOptional

Internal unique identifier/key for this message

formattedMessagestringOptional

formatted message (default language)

Responses

200

OK

*/*

put

/cmn/users/me/messages/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/users/me/messages/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "messageCode": "text",
  "messageParameters": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "formattedMessage": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "recipientRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "senderRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "senderBotAlias": "text",
  "sendTime": "2026-02-10T14:20:24.097Z",
  "updateTime": "2026-02-10T14:20:24.097Z",
  "lastRead": "2026-02-10T14:20:24.097Z",
  "state": "SEEN",
  "message": {
    "messageCode": "text",
    "messageParameters": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "formattedMessage": "text"
  },
  "priority": "HIGH"
}

delete a message

delete

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

delete

/cmn/users/me/messages/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/me/messages/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

post a message

post

Body

application/json

Nachricht-Umschlag zum verschicken

recipientUserIdsinteger · int64[]Optional

Empfänger User

recipientGroupIdsinteger · int64[]Optional

Empfänger User-Gruppen (werden zu Usern)

senderBotAliasstringOptional

optional ein BotName als versender. Nur für interne Apps und darf nur mit leeren userIds/groupIds verwendet werden

Responses

200

OK

*/*

post

/cmn/users/me/messages

HTTPcURLJavaScriptPython

POST /api/cmn/users/me/messages HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "recipientUserIds": [
    1
  ],
  "recipientGroupIds": [
    1
  ],
  "senderBotAlias": "text",
  "message": {
    "messageCode": "text",
    "messageParameters": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "formattedMessage": "text"
  }
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:20:24.097Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:20:24.097Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "recipientRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "senderRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "senderBotAlias": "text",
  "sendTime": "2026-02-10T14:20:24.097Z",
  "updateTime": "2026-02-10T14:20:24.097Z",
  "lastRead": "2026-02-10T14:20:24.097Z",
  "state": "SEEN",
  "message": {
    "messageCode": "text",
    "messageParameters": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "formattedMessage": "text"
  },
  "priority": "HIGH"
}

return message count for specific user

get

Path parameters

idinteger · int64Required

Query parameters

statestring · enumOptionalPossible values:

Responses

200

OK

*/*

Responseinteger · int64

get

/cmn/users/{id}/messages/count

HTTPcURLJavaScriptPython

GET /api/cmn/users/{id}/messages/count HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

1

return message count for user

get

Query parameters

statestring · enumOptionalPossible values:

Responses

200

OK

*/*

Responseinteger · int64

get

/cmn/users/me/messages/count

HTTPcURLJavaScriptPython

GET /api/cmn/users/me/messages/count HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

1

delete a message

delete

Path parameters

userIdinteger · int64Required

idinteger · int64Required

Responses

200

OK

*/*

delete

/cmn/users/{userId}/messages/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/{userId}/messages/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

delete all seen messages

delete

Responses

200

OK

*/*

delete

/cmn/users/me/seen-messages

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/me/seen-messages HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

delete all messages

delete

Responses

200

OK

*/*

delete

/cmn/users/me/all-messages

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/me/all-messages HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}