Section ID:
DOC-API-MODEL-schema-ok4lj6t1ka#overview
OperationStatus
Mirrors Novu's common delete/mutate acknowledgement response.
Meaning and usage
Section ID: DOC-API-MODEL-schema-ok4lj6t1ka#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ok4lj6t1ka#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-ok4lj6t1ka#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ok4lj6t1ka#field-acknowledgedSection ID: DOC-API-MODEL-schema-ok4lj6t1ka#response-field-acknowledgedacknowledged | boolean | Optional | Whether the provider acknowledged the requested operation. |
Section ID: DOC-API-MODEL-schema-ok4lj6t1ka#field-statusSection ID: DOC-API-MODEL-schema-ok4lj6t1ka#response-field-statusstatus | string | Optional | See meaning below. |
status
Status reported by the notification provider.
e.g., "done", "deleted"
Where used
Section ID: DOC-API-MODEL-schema-ok4lj6t1ka#where-used
| Reference | Relationship |
|---|---|
| Archive an inbox message | POST /api/v1/notifications/archive-inbox-message |
| Complete an inbox message action | POST /api/v1/notifications/complete-inbox-action |
| Delete an inbox message | POST /api/v1/notifications/delete-inbox-message |
| Delete the caller's subscriber profile | POST /api/v1/notifications/manage/delete-subscriber |
| Delete a notification topic | POST /api/v1/notifications/manage/delete-topic |
| Revert an inbox message action | POST /api/v1/notifications/revert-inbox-action |
| Unarchive an inbox message | POST /api/v1/notifications/unarchive-inbox-message |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-ok4lj6t1ka