TopicSubscriptionResult
Result of a topic subscription operation (add/remove subscribers). Novu returns partial success — some subscribers may fail while others succeed.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
totalCount | integer (int32) | Optional | Total number of matching entries reported by the operation. Minimum: -2147483648. Maximum: 2147483647. |
successful | integer (int32) | Optional | Number of subscribers accepted by the topic subscription operation. Minimum: -2147483648. Maximum: 2147483647. |
failed | integer (int32) | Optional | Number of subscribers rejected by the topic subscription operation. Minimum: -2147483648. Maximum: 2147483647. |
errors | Array of TopicSubscriptionError | Optional | Errors reported while processing notification requests. |
Where used
| Reference | Relationship |
|---|---|
| Add subscribers to a topic | POST /api/v1/notifications/manage/add-subscribers-to-topic |
| Remove subscribers from a topic | POST /api/v1/notifications/manage/remove-subscribers-from-topic |
Download the public reference contract.
Document: DOC-API-MODEL-topic-subscription-result.