CreateSubscription

post

https://{yourlidiaurl}/notification/notifications/subscription/create

Creates a new notification subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The details of the subscription to create.

Represents the parameters required to create, update, or delete a notification subscription.

subscriptionId

string

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

Gets or sets the unique subscription identifier (used for updates and deletions).

eventId

string

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

Gets or sets the identifier of the event associated with this subscription.

address

string | null

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

addressName

string | null

Gets or sets the friendly display name of the recipient.

type

channel

string

enum

Allowed values: Mail (10), SMS (20), Whatsapp (30), Account (40).

Allowed:

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 created subscription details.