Notifications API
Manage notifications, categories, and contacts with the Notifications API.
The Notifications API allows you to manage and deliver notifications within the SoftwareOne Marketplace Platform. With this API, you can:
Create and retrieve notification batches (emails) sent to specific categories and contacts. You can also retrieve attachments associated with those messages.
Create and manage notification categories (such as orders, subscriptions, and more).
Create and manage contacts. Contacts are the recipients who receive notifications.
Retrieve sent messages and delivery information.
Before you start
Review the shared API docs before you work with notifications resources.
Core concepts
The Notifications API is built around the following core resources:
Batch – Represents an email being sent to a specific category and multiple contacts.
Category – Represents a logical grouping of notifications (for example, orders or subscriptions). Categories help organize and control notification types.
Contact – Represents a contact who receives the notifications.
Message – Represents an individual notification sent to a contact, including delivery details and status.
Subscriber – Handles the configuration of notifications for accounts. It's the connection between an account and a notification category.
Browse collections
The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.
Use the following links to jump to the collection you need:
Batches
Categories
Contacts
Footer
Message
Subscriber
Template
Template Variant
Last updated
Was this helpful?