NotificationSubscriptionUpdateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
DTO for updating an existing notification subscription. Includes concurrency stamp for optimistic concurrency control.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
name
required |
string | Subscription name.
nullablemax length 256
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
description
required |
string | Optional description.
nullablemax length 1024
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
isEnabled
required |
boolean | Whether the subscription is enabled.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
scope
required |
SubscriptionScope SubscriptionScope | Organizational scope.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
resellerId
required |
string (uuid) | Reseller ID (required for reseller scope).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
merchantId
required |
string (uuid) | Merchant ID (required for merchant scope).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
resellerPathPrefix
required |
string | Reseller path prefix (required for reseller scope).
nullablemax length 512
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
eventTypes
required |
array of string array of | Event types to subscribe to (at least one required).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
filterExpressionJson
required |
string | Serialized filter expression JSON (null for no filter).
nullablemax length 8192
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
channelIds
required |
array of string (uuid) array of | Channel IDs to route notifications through.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
concurrencyStamp
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.