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.

Try APIDownload API

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.

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.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Batches

Capability	Client	Vendor	Operations
List batches	❌	✅	✅
Get batch	❌	✅	✅
Create batch	❌	✅	✅
Get batch attachment	✅	✅	✅

Categories

Capability	Contact	Client	Vendor	Operations
List categories	✅	✅	✅	✅
Get category	✅	✅	✅	✅
Create category	❌	❌	❌	✅
Update category	❌	❌	❌	✅
Publish category	❌	❌	❌	✅
Unpublish category	❌	❌	❌	✅
Delete category	❌	❌	❌	✅

Contacts

Capability	Contact	Client	Vendor	Operations
List contacts	✅	✅	✅	✅
Get contact	✅	✅	✅	✅
Create contact	❌	❌	❌	✅
Update contact	✅	✅	✅	✅
Block contact	❌	❌	❌	✅
Unblock contact	❌	❌	❌	✅
Delete contact	❌	❌	❌	✅

Footer

Capability	Client	Vendor	Operations
List footers	❌	❌	✅
Get footer	❌	❌	✅
Create footer	❌	❌	✅
Update footer	❌	❌	✅
Delete footer	❌	❌	✅

Messages

Capability	Client	Vendor	Operations
List messages	✅	✅	✅
Get message	✅	✅	✅

Subscribers

Capability	Client	Vendor	Operations
List subscribers	✅	✅	✅
Get subscriber	✅	✅	✅
Disable subscriber	✅	✅	✅
Enable subscriber	✅	✅	✅
Update subscriber	✅	✅	✅
Get contacts in account and category	❌	✅	✅

Templates

Capability	Client	Vendor	Operations
List templates	❌	✅	✅
Create template	❌	✅	✅
Get template	❌	✅	✅
Update template	❌	✅	✅
Delete template	❌	✅	✅
Activate template	❌	✅	✅

Template Variant

Capability	Client	Vendor	Operations
List template variant	❌	✅	✅
Create template variant	❌	✅	✅
Get template variant	❌	✅	✅
Update template variant	❌	✅	✅
Delete template variant	❌	✅	✅