Sends a new message

post

https://messaging.api.eu1.scalar.zf.com/v1/actions/send-message

Sends a message to a user using multipart/form-data. Required fields vary depending on contentType. For example:

content (string) is required only if contentType is 'text'.
file (binary) is expected if contentType is 'image' or 'file'.

Supported for direct chat conversations (conversationType=chat).

File size limits:

contentType image: maximum 2 MB per file. Exceeding this limit returns a 400 Bad Request with error type fileTooLarge.
contentType file: maximum 5 MB per file. Exceeding this limit returns a 413 Request Entity Too Large.

Body Params

senderId

uuid

required

participantId of the participant sending the message.

recipientId

uuid

required

participantId of the participant receiving the message.

conversationType

string

enum

Defaults to chat

Type of conversation. Only 'chat' (direct chats) is supported. Defaults to 'chat' if not provided.

Allowed:

contentType

string

enum

required

Type of message content. Determines which fields are required and which file size limits apply:

text: requires the content field.
image: requires the file field. Maximum file size is 2 MB.
file: requires the file field. Maximum file size is 5 MB.

Allowed:

content

string

Required only if contentType is 'text'.

file

The file to upload. Required when contentType is 'image' or 'file'. Maximum size: 2 MB for images, 5 MB for files.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Message sent successfully.

400Failure code. The request was unacceptable. This includes cases where an image file exceeds the 2 MB size limit (error type: fileTooLarge).

401Failure code. Unauthorized access.

403Forbidden

413Request payload too large. The uploaded file exceeds the maximum allowed size of 5 MB.

429Too many incoming requests.

500Failure code. Indicates an internal server error (unhandled exception).