Section ID:
DOC-API-MODEL-schema-p2eb0gb1ln#overview
TopicSubscriptionResult
Result of a topic subscription operation (add/remove subscribers). Novu returns partial success — some subscribers may fail while others succeed.
Meaning and usage
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#field-totalcountSection ID: DOC-API-MODEL-schema-p2eb0gb1ln#response-field-totalcounttotalCount | string (int64) | Optional | Total number of subscribers reported for the membership-change result. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#field-successfulSection ID: DOC-API-MODEL-schema-p2eb0gb1ln#response-field-successfulsuccessful | string (int64) | Optional | Number of subscribers accepted by the topic subscription operation. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#field-failedSection ID: DOC-API-MODEL-schema-p2eb0gb1ln#response-field-failedfailed | string (int64) | Optional | Number of subscribers rejected by the topic subscription operation. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#field-errorsSection ID: DOC-API-MODEL-schema-p2eb0gb1ln#response-field-errorserrors | Array of TopicSubscriptionError | Optional | Errors reported while processing notification requests. |
Where used
Section ID: DOC-API-MODEL-schema-p2eb0gb1ln#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 ID: DOC-API-MODEL-schema-p2eb0gb1ln