HomeGuidesAPI Reference
API Reference

Send message

post
https://example.com/messages/send

Send a message to a group of users. Each attachment is limited to 1 GB (configurable per deployment); a larger upload is rejected with 413 Payload Too Large, and an upload that stalls is closed with 408 Request Timeout.

Body Params
string
required

message subject or title

string
required

message body

correspondent
required
recipients
array of objects
required

Collections of owners ids to send the message to

recipients*
attachments
object

Collection optional attachments

Headers
string

32 bytes buffer (24 randomly generated bytes by the client + 8 bytes epoch timestamp seconds) encoded to hex:

const nonce = Buffer.alloc(32);
nonce.fill(crypto.randomBytes(24), 0, 24);

const nowEpochSeconds = Math.floor(new Date().getTime() / 1000);
const t = BigInt(nowEpochSeconds);
nonce.writeBigInt64BE(t, 24);

Responses

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago