GET   messages/{id}

Gets an existing UI message by Id.

URL Parameters

NameDescription
id

The message's numeric identifier.

Request example

Response body model example and description

Message

{
  "id": 1,
  "text": "sample string 2",
  "message_is_from": "sample string 3",
  "from_date_utc": "2024-09-27T22:23:04",
  "to_date_utc": "2024-09-27T22:23:04",
  "importance": "sample string 6",
  "enabled": true,
  "customer_id": 1,
  "include_sub_customers": true
}
NameType Description
idInteger

The message's numeric identifier.

textString

Text of the message.

message_is_fromString

Text about the message sender.

from_date_utcDateTime

Message activity start date and time.

to_date_utcDateTime

Message activity end date and time.

importanceString

Message importance. Possible values: "L"/"H"/"C" ("Low","High","Critical").

enabledBoolean

Indicates whether the message is enabled or not.

customer_idInteger

Customer Id. Сustomer who’s users will get the message.

include_sub_customersBoolean

Include sub-customers users as targets of the message.