notifications-api

description	Manage notifications, categories, and contacts with the Notifications API.

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.

• Authentication
• URL structure
• Error handling

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

Batches

View Batches operations

Operation	Method	Description	Access
Create batch	POST	Creates a new batch.	vendor, ops
List batches	GET	Gets a list of batches.	vendor, ops
Get batch by id	GET	Gets batch details.	vendor, ops
Get batch attachment	GET	Gets a batch attachment.	vendor, client, ops

Categories

View Categories operations

Operation	Method	Description	Access
Create category	POST	Creates a new notification category.	ops
List categories	GET	Gets a list of notification categories.	vendor, client, ops, contact
Get category by id	GET	Gets notification category details.	vendor, client, ops, contact
Update category	PUT	Updates a notification category.	ops
Delete category	DELETE	Deletes a notification category.	ops
Publish category	POST	Publishes a notification category.	ops
Unpublish category	POST	Unpublishes a notification category.	ops

Contacts

View Contacts operations

Operation	Method	Description	Access
Create contact	POST	Creates a new contact.	ops
List contacts	GET	Gets a list of contacts.	vendor, client, ops, contact
Get contact by id	GET	Gets contact details.	vendor, client, ops, contact
Update contact	PUT	Updates a contact.	vendor, client, ops, contact
Delete contact	DELETE	Deletes a contact.	ops
Block contact	POST	Blocks a contact.	ops
Unblock contact	POST	Unblocks a contact.	ops

Footer

View Footer operations

Capability	Method	Description	Access
Create footer	POST	Creates a new footer.	ops
Get footer	GET	Retrieves a footer by id.	ops
List footer	GET	Retrieves all footers.	ops
Update footer	PUT	Updates the footer content or sets it as default.	ops
Delete footer	DELETE	Permanently removes the footer.	ops

Message

View Message operations

Capability	Method	Description	Access
List messages	GET	Retrieves all messages.	vendor, client, ops
Get message	GET	Get a message by id.	vendor, client, ops

Subscriber

View Subscriber operations

Operation	Method	Description	Access
List subscribers	GET	Gets a list of subscribers.	vendor, client, ops
Get subscriber by id	GET	Gets subscriber details.	vendor, client, ops
Update subscriber	PUT	Modifies recipients of a given configuration.	vendor, client, ops
Disable subscriber	POST	Disables the category for the account.	vendor, client, ops
Enable subscriber	POST	Enables the category for the account.	vendor, client, ops
Get contacts in account and category	GET	Returns contacts configured to receive notifications for the given account and category.	vendor, ops

Template

View Template operations

Capability	Method	Description	Access
List templates	GET	Gets a list of template.	vendor, ops
Create template	POST	Creates a new template.	vendor, ops
Get template	GET	Gets template details.	vendor, ops
Update template	PUT	Updates template properties. Only speciic fields can be modified.	vendor, ops
Delete template	DELETE	Permanently removes the template and all its language variants	vendor, ops
Activate template	POST	Activates the template, making it available for sending notifications.	vendor, ops

Template Variant

View Template Variant operations

Capability	Method	Description	Access
List template variant	GET	Gets a list of template variants	vendor, ops
Create template variant	POST	Adds a new language variant to the template with subject and body content for the specified language.	vendor, ops
Get template variant	GET	Gets a template variant.	vendor, ops
Update template variant	PUT	Updates the subject and/or body content of the language variant. Only specific fields can be modified.	vendor, ops
Delete template variant	DELETE	Permanently removes the language variant from the template.	vendor, ops