PUT   messages/{id}

Updates an existing UI message.

URL Parameters

NameDescription
id

Message Id.

Request body model example and description

Message

{
  "text": "sample string 1",
  "message_is_from": "sample string 2",
  "from_date_utc": "2019-08-21T12:31:47",
  "to_date_utc": "2019-08-21T12:31:47",
  "importance": "L",
  "enabled": true,
  "customer_id": 1,
  "include_sub_customers": true
}
NameType Required Description
text String No

Text of the message. You can use the following styling: Link ([link="link url"]Link Text[/link]), Bold ([b]Bold Text[/b]), Italic ([i]Italic Text[/i]), Italic and bold ([ib]Italic and Bold Text[/ib].

message_is_from String No

Text about the message sender.

from_date_utc DateTime No

Message activity start date and time.

to_date_utc DateTime No

Message activity end date and time.

importance String No

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

enabled Boolean No

Indicates whether the message is enabled or not.

customer_id Integer No

Customer Id. Сustomer who’s users will get the message. For the root administrators: Set value to '0' to make message for all users of all customers.

include_sub_customers Boolean No

Include sub-customers users as targets of the message.