POST   messages

Creates an UI message.

Request body model example and description

Message

{
  "text": "sample string 1",
  "message_is_from": "sample string 2",
  "from_date_utc": "2019-12-14T04:49:51",
  "to_date_utc": "2019-12-14T04:49:51",
  "importance": "L",
  "enabled": true,
  "customer_id": 1,
  "include_sub_customers": true
}
NameType Required Description
text String Yes

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 Yes

Text about the message sender.

from_date_utc DateTime Yes

Message activity start date and time.

to_date_utc DateTime Yes

Message activity end date and time.

importance String No

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

enabled Boolean No

Indicates whether the message is enabled or not. Default value is 'false'.

customer_id Integer No

Customer Id. Сustomer who’s users will get the message. For the customer administrators: if customer Id is not specified then message will be created for users of the current customer. For the root administrators: if customer Id is not specified then message will be created for all users of all customers.

include_sub_customers Boolean No

Include sub-customers users as targets of the message. Default value is 'false'.