UpdateDeliveryState

post

https://{yourlidiaurl}/notification/notifications/delivery/state/update

Updates the state of a notification delivery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The details of the delivery update.

Represents the parameters required to update the state of a notification delivery.

channelMessageId

string | null

Gets or sets the unique transaction or message identifier provided by the downstream channel provider.

notificationId

string

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

Gets or sets the parent notification identifier.

deliveryId

string

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

Gets or sets the unique delivery record identifier.

address

string | null

Gets or sets the destination address for the delivery update.

state

string

enum

Allowed values: Pending (0), Sent (1), Delivered (2), Read (3), Clicked (4), Deleted (-99), Cancelled (-9), Dropped (-5), Bounced (-4), ComplaintAsSpam (-3), Unsubscribed (-2), Error (-1).

bulkUpdate

boolean

Gets or sets a value indicating whether to perform a bulk state update.

deliveryIds

array | null

Gets or sets the list of delivery identifiers for a bulk update operation.

deliveryIds

environment

string | null

Gets or sets the execution environment name.

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the authentication token of the active user.

sessionId

string | null

Gets or sets the unique session identifier.

userId

string

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

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

userIP

string | null

Gets or sets the IP address of the active user.

threadId

string | null

Gets or sets the correlation thread identifier.

status

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:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200A response containing the updated delivery details.