Skip to content

MessageThread ​

CRUD functionality as well as additional methods for Message threads. Messages thread groups together a set of related messages and/or attachments.

Salaxy API v03, Finland only. 10 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.

The reference wins

These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.

GET /v03/api/messages ​

Performs an OData query to the search index.

ParameterInTypeRequiredDescription
$searchquerystring
$filterquerystringSpecifies the logic to pull back a subset of records.
$orderbyquerystringSpecifies the values used to sort the collection of entries.
$selectquerystringThe $select system query option allows the clients to requests a limited set of properties for each entry.
$topquerynumberSpecifies the subset of entries by count.
$skipquerynumberSpecifies the count of entries to skip.
$countquerybooleanIndicates whether or not to include a total entry count.

Response: PageResultOfMessageListItem

Try it: interactive reference

POST /v03/api/messages ​

Updates or creates a new object

Request body: MessageThread (required)

Response: MessageThread

Try it: interactive reference

GET /v03/api/messages/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object

Response: MessageThread

Try it: interactive reference

DELETE /v03/api/messages/{id} ​

Deletes an object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v03/api/messages/new ​

Factory method that creates a new object

Response: MessageThread

Try it: interactive reference

POST /v03/api/messages/{id}/messages ​

Adds or modifies a message to the thread.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier of the thread

Request body: Message (required)

Response: MessageThread

Try it: interactive reference

POST /v03/api/messages/{id}/files ​

Saves an attachment file as a message to the thread.

ParameterInTypeRequiredDescription
idpathstringyesMessage thread identifier

Response: MessageThread

Try it: interactive reference

POST /v03/api/messages/{id}/messages/blobFileMessage ​

Saves an attachment file as a message to the thread.

ParameterInTypeRequiredDescription
idpathstringyesMessage thread identifier

Response: MessageThread

Try it: interactive reference

POST /v03/api/messages/{id}/read-by/{readBy} ​

Marks all messages as read by a given party

ParameterInTypeRequiredDescription
idpathstringyesIdentifier of the thread
readBypathMessageFromyesThe party for which the messages are marked as read.

Response: MessageThread

Try it: interactive reference

POST /v03/api/messages/{id}/notifications ​

Sends an email notification to the owner of the message.

ParameterInTypeRequiredDescription
idpathstringyesMessage thread identifier.
subjectquerystringSubject for the notification.

Request body: string (required)

Response: MessageThread

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.