Creates a ChatMessage resource.

POST

/api/external_chat_messages

POST

/api/external_chat_messages

curl -X POST "/api/external_chat_messages" \
  -H "apikey: $MEDIALISTER_API_KEY" \
  -H "Content-Type: application/ld+json" \
  -d '{
  "order": "/api/orders/a0a94ced-47ab-4f78-828f-97bc5d0e3dc9",
  "externalCustomerId": "acme-client-42",
  "content": "This is a new message"
}'

Authorization

apikey
string
header
required
Value for the apikey header parameter.

Body

application/ld+json

The new ChatMessage resource

order
string
required
externalCustomerId
string
required
The end client the message is written for. Must be the order's external customer.
content
string
required

Response

application/ld+json

ChatMessage resource created

@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_chatMessage.external.read | null
externalCustomerId
string | null
The end client an API client wrote the message for, always the order's external customer.
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"
  },
  "externalCustomerId": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

curl -X POST "/api/external_chat_messages" \ -H "apikey: $MEDIALISTER_API_KEY" \ -H "Content-Type: application/ld+json" \ -d '{ "order": "/api/orders/a0a94ced-47ab-4f78-828f-97bc5d0e3dc9", "externalCustomerId": "acme-client-42", "content": "This is a new message" }'

{ "@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" }, "externalCustomerId": "string", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2026-01-15T09:30:00Z", "updatedAt": "2026-01-15T09:30:00Z" }