API Reference
  1. Lidia Notification
  2. Notification > Notifications > Notification

SetNotification

post
https://{yourlidiaurl}/notification/notifications/set

Records or queues a notification request without triggering immediate delivery.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the notification to queue.

Represents the parameters required to send or set a notification.

string
enum

Allowed values: Email (1), SMS (2), Event (3).

Allowed:
string | null

Gets or sets the channel code configuration to deliver through.

string | null

Gets or sets the code identifying the layout template.

string | null

Gets or sets the filesystem or virtual path of the template file.

string | null

Gets or sets the visibility scope of the notification configuration.

string | null

Gets or sets the title or subject line.

string | null

Gets or sets the main content body.

string | null

Gets or sets the friendly sender display name.

string | null

Gets or sets the sender address (e.g. email address or phone number).

boolean

Gets or sets a value indicating whether the body content contains HTML format.

string
enum

Allowed values: None (0), NewOrder (10), RefundOrder (11), CancelOrder (12), DelayedOrder (13), OrderStatusChanged (14), NewDelivery (20), DeliveryStatusChanged (21), DeliveryAddressChanged (22), ProductOutOfStock (31), ProductLowStock (32), CouponCreated (40), PromotionCreated (45), PromotionStarted (46), MerchantCreated (50), ProductUpdated (60), VariantUpdated (65), DataSchemaCreated (70), DataSchemaUpdated (71), DataSchemaDeleted (72), PropertyCreated (80), PropertyUpdated (81), PropertyDeleted (82), OptionCreated (94), OptionUpdated (95), OptionDeleted (96), OptionValueCreated (97), OptionValueUpdated (98), OptionValueDeleted (99), CategoryCreated (100), CategoryUpdated (101), CategoryDeleted (102), TrademarkCreated (110), TrademarkUpdated (111), TrademarkDeleted (112), CustomListCreated (120), CustomListUpdated (121), CustomListDeleted (122), TagCreated (130), TagUpdated (131), TagDeleted (132), ProductTagAdded (140), ProductTagRemoved (141), VariantTagAdded (145), VariantTagRemoved (146), LimitExceeded (150).

string | null

Gets or sets the payload raw data values in JSON string format.

attachments
array of objects | null

Gets or sets the list of attached files to deliver alongside the notification.

attachments
recipients
array of objects | null

Gets or sets the list of target recipients who should receive the notification.

recipients
properties
array of objects | null

Gets or sets the custom key-value metadata parameters.

properties
string | null

Gets or sets the execution environment name.

string | null

Gets or sets the IP address of the calling application.

string | null

Gets or sets the authentication token of the active user.

string | null

Gets or sets the unique session identifier.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the identifier of the user initiating the request.

string | null

Gets or sets the IP address of the active user.

string | null

Gets or sets the correlation thread identifier.

string
enum

Allowed values: Draft (0), Active (1), Unknown (-999), Deleted (-99), Blocked (-12), Freezed (-11), Test (-9), Passive (-1).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Updated 17 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 17 days ago

Did this page help you?