POST
/
chat
/
v2
/
{id}
/
send
Send a chat message
curl --request POST \
  --url http:localhost:3000/v2/chat/v2/{id}/send \
  --header 'Content-Type: application/json' \
  --header 'x-API-Key: <api-key>' \
  --data '{
  "_id": "<string>",
  "number": 123,
  "companyId": "<string>",
  "status": {
    "status": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedAt": "2023-11-07T05:31:56Z",
    "lastModifiedBy": "<string>"
  },
  "type": "CHAT_MESSAGE",
  "chatId": "<string>",
  "blocks": [
    {}
  ],
  "childMessageIds": [
    "<string>"
  ],
  "readByUserIds": [
    "<string>"
  ],
  "metadata": {
    "type": "<string>",
    "subId": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "initialTab": "<string>"
  },
  "accessLevel": {
    "_id": "<string>",
    "level": 123,
    "name": "<string>"
  },
  "parentMessageId": "<string>"
}'
{
  "_id": "<string>"
}

Authorizations

x-API-Key
string
header
required

Path Parameters

id
string<objectid>
required

Chat ID

Body

application/json

Base message structure for chat, note, activity, and email messages. Base class for all entities in the system, providing common properties and methods.

Response

200
application/json

Message sent

The response is of type object.