Updates the ChatMessage resource.

PATCH

/api/chat_messages/{id}/read

PATCH

/api/chat_messages/{id}/read

curl -X PATCH "/api/chat_messages/{id}/read" \
  -H "apikey: $MEDIALISTER_API_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
  "senderUser": "https://example.com/",
  "conversation": "https://example.com/"
}'

Authorization

apikey
string
header
required
Value for the apikey header parameter.

Parameters

id
string
path
required
ChatMessage identifier

Body

application/merge-patch+json

The updated ChatMessage resource

content
string
senderType
enum<integer> | null
One of:
0
1
2
senderName
string
publicSenderName
string | null
senderUser
string<iri-reference> | null
adminId
string | null
externalCustomerId
string | null
The end client an API client wrote the message for, always the order's external customer.
conversation
string<iri-reference>
chatMessagesRead
ChatMessageRead[]
readAt
string<date-time> | null
id
string<uuid>
createdAt
string<date-time>
updatedAt
string<date-time>
ownMessage
boolean

Response

application/ld+json

ChatMessage resource updated

@context
one of
@id
string
required
@type
string
required
content
string
required
senderType
enum<integer> | null
One of:
0
1
2
senderName
string
required
publicSenderName
string | null
senderUser
ClientUser.jsonld-all.read | null
id
string<uuid>
createdAt
string<date-time>
updatedAt
string<date-time>

{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "content": "string",
  "senderType": 0,
  "senderName": "string",
  "publicSenderName": "string",
  "senderUser": {
    "@context": "string",
    "@id": "string",
    "@type": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "country": "/api/geo_locations/0a097745-ff39-4659-8cae-a9bfb596a124",
    "email": "string",
    "phone": "+111 11111111",
    "fullName": "John Doe",
    "confirmedAt": "2026-01-15T09:30:00Z",
    "invitedAt": "2026-01-15T09:30:00Z",
    "bannedUntil": "2026-01-15T09:30:00Z",
    "referredBy": "string",
    "createdAt": "2026-01-15T09:30:00Z",
    "updatedAt": "2026-01-15T09:30:00Z",
    "publicId": "string"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

curl -X PATCH "/api/chat_messages/{id}/read" \ -H "apikey: $MEDIALISTER_API_KEY" \ -H "Content-Type: application/merge-patch+json" \ -d '{ "senderUser": "https://example.com/", "conversation": "https://example.com/" }'

{ "@context": "string", "@id": "string", "@type": "string", "content": "string", "senderType": 0, "senderName": "string", "publicSenderName": "string", "senderUser": { "@context": "string", "@id": "string", "@type": "string", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "country": "/api/geo_locations/0a097745-ff39-4659-8cae-a9bfb596a124", "email": "string", "phone": "+111 11111111", "fullName": "John Doe", "confirmedAt": "2026-01-15T09:30:00Z", "invitedAt": "2026-01-15T09:30:00Z", "bannedUntil": "2026-01-15T09:30:00Z", "referredBy": "string", "createdAt": "2026-01-15T09:30:00Z", "updatedAt": "2026-01-15T09:30:00Z", "publicId": "string" }, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2026-01-15T09:30:00Z", "updatedAt": "2026-01-15T09:30:00Z" }