Skip to content

Add messages

POST
/api/connector/v1/messages/add

Add the specified messages to the specified Message threads. You can only add messages to message threads that you have created.

MultipleMessageAddParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Messages
required

Messages to be added.

Array<object>
<= 1000 items
MessageAddParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
MessageThreadId
required
string format: uuid
Text
required
string
>= 1 characters
Identifier
string
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"Messages": [
{
"Text": "Text of the message",
"MessageThreadId": "8d02142f-31cf-4115-90bf-ae5200c7a1ba",
"Identifier": "Message 1"
}
]
}

OK

AddedMessageResult
object
Messages
required
Array<object>
AddedMessage
object
Identifier
string
nullable
Message
object
Id
required

Unique identifier of the message.

string format: uuid
MessageThreadId
required

Unique identifier of the Message thread which the message belongs to.

string format: uuid
Text
required

Text of the message.

string
>= 1 characters
Sender
required
string
Allowed values: Application Enterprise
CreatedUtc
required

Creation date and time of the message in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Example
{
"Messages": [
{
"Identifier": "string",
"Message": {
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"MessageThreadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Text": "string",
"Sender": "Application",
"CreatedUtc": "2024-04-11T08:54:47.193Z"
}
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable