Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Active
The footer is available for use.
Deleted
The footer is deleted.
Indicates the subscriber has been disabled.
Draft
The template is currently in draft and not ready for use.
Active
The template is active and can be used.
Disabled
The template has been disabled temporarily. It can be reactivated when needed.
Deleted
The template has been deleted.
The following diagram shows the state (status) transition process of a notification message.
New
This is the initial status for newly created email messages. This state is not visible on the interface.
Queued
The email has been queued for sending to the recipient.
Discarded
The email has been discarded because the individual or account has disabled the category, or the contact has placed an administrative block due to bounces or complaints.
Sent
The email message has been sent to the recipient.
Failed
The platform was unable to send the email message.
Bounced
The email message bounced and couldn't be delivered. This could be due to several reasons, including invalid email addresses, issues with the recipient's mailbox, and so on.
Complained
The recipient has reported the email message as spam or junk.
The Webhook object represents an endpoint of an external system that should be invoked for specific events within the Marketplace Platform.
This object contains the following attributes:
id
failures
number
(Read-only) Total number of failed calls made from the platform to an external system represented by the Webhook object.
failuresSinceLastSuccess
number
(Read-only) Total number of failed calls since the last successful call made by the platform to an external system, represented by the Webhook object.
failures
number
(Read-only) Total number of failed calls made from the platform to an external system represented by the webhook object.
failuresSinceLastSuccess
number
(Read-only) Total number of failed calls since the last successful call made by the platform to an external system, represented by the webhook object.
string
(Read-only) The webhook's unique identifier.
href
string
(Read-only) The relative reference to the object within the API.
description
string
A description of the webhook.
status
enum
The status of the webhook. Allowed values are enabled or disabled.
type
enum
Defines what the webhook is designed for. Allowed values are:
validatePurchaseOrderDraft
validatePurchaseOrderQuerying
validateChangeOrderDraft
validateTerminateOrder
validateRequest
validateAccount
selectOrderLines
objectType
enum
Object that triggers the webhook event. Allowed values are:
Order
Request
Account
url
string
The webhook endpoint URL. Only https:// endpoints are allowed.
criteria
object
(Read-only) A set of key-value objects required in the webhook payload to trigger the webhook call.
statistics
object
(Read-only) Represents the statistics object containing statistical and debug information regarding webhook executions.
lastSuccess
object
(Read-only) Represents the call object containing the last successful call to the webhook URL.
lastFailure
object
(Read-only) Represents the call object with details of the last failed call to the webhook URL.
lastCall
object
(Read-only) Represents the call object with details of the last call to the webhook URL.
secret
string
The secret used for authorization in the third-party systems. It's returned only once in response to the Create Webhook endpoint.
account
object
(Read-only) Represents the vendor account object.
audit
object
(Read-only) Represents the audit object.
total
number
(Read-only) Total number of calls made from the platform to the external system represented by the Webhook object.
successes
number
total
number
(Read-only) Total number of calls made from the platform to the external system represented by the webhook object.
successes
number
(Read-only) Total number of successful calls made from the platform to an external system represented by the Webhook object.
(Read-only) Total number of successful calls made from the platform to an external system represented by the webhook object.
{
"id": "WBH-5433-8787",
"href": "/notifications/webhooks/WBH-5433-8787",
"description": "Webhook for some products"
"account": {
"id": "ACC-7362-0233",
"href": "/accounts/accounts/ACC-7362-0233",
"name": "Adobe",
"icon": "/static/ACC-7362-0233/account.png"
},
"objectType": "order",
"type": "validatePurchaseOrderDraft",
"params": {
"product.id": "PRD-6233-9657"
},
"status": "enabled",
"url": "https://my-webhook.endpoint.com/validation",
"secret": "*******************",
"statistics": {
"total": 1234,
"successes": 1132,
"failures": 101,
"failuresSinceLastSuccess": 2
},
"lastSuccess": {
"success": true,
"callTime": "2024-12-12T11:11:11",
"responseTime": "2024-12-12T11:12:03",
"httpStatusCode": "200",
"reasonPhrase": "OK",
"headers": {
"Date": "Wed, 15 May 2024 10:16:56 GMT",
},
"error": null,
"response": { ... }
},
"lastFailure": {
"success": true,
"callTime": "2024-12-12T11:11:11",
"responseTime": "2024-12-12T11:12:03",
"status": "401",
"reasonPhrase": "Auth Error",
"response": "Unauthenticated",
"headers": {
"Date": "Wed, 15 May 2024 10:16:56 GMT",
},
"error": "JWT Token was invalid",
"response": null,
},
"lastCall": {
"success": true,
"callTime": "2024-12-12T11:11:11",
"responseTime": "2024-12-12T11:12:03",
"httpStatusCode": "200",
"reasonPhrase": "OK",
"headers": {
"Date": "Wed, 15 May 2024 10:16:56 GMT",
},
"error": null,
"response": { ... }
},
"audit": {
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
},
}The following diagram shows the state (status) transition process of a contact on the platform.
New
This is the initial status for a new contact.
Active
A contact in this state can receive emails from the platform, depending on their preferences.
Blocked
A contact in this state will not receive the email, but the platform will generate a message.
Deleted
Deleted contacts cannot be used for notifications.
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.
Review the shared API docs before you work with notifications resources.
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.
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:
Subscriber – Handles the configuration of notifications for accounts. It's the connection between an account and a notification category.
POST
Creates a new batch.
vendor, ops
GET
Gets a list of batches.
vendor, ops
GET
Gets batch details.
vendor, ops
GET
Gets a batch attachment.
vendor, client, ops
POST
Creates a new notification category.
ops
GET
Gets a list of notification categories.
vendor, client, ops, contact
GET
Gets notification category details.
vendor, client, ops, contact
PUT
Updates a notification category.
ops
DELETE
Deletes a notification category.
ops
POST
Publishes a notification category.
ops
POST
Unpublishes a notification category.
ops
POST
Creates a new contact.
ops
GET
Gets a list of contacts.
vendor, client, ops, contact
GET
Gets contact details.
vendor, client, ops, contact
PUT
Updates a contact.
vendor, client, ops, contact
DELETE
Deletes a contact.
ops
POST
Blocks a contact.
ops
POST
Unblocks a contact.
ops
POST
Creates a new footer.
ops
GET
Retrieves a footer by id.
ops
GET
Retrieves all footers.
ops
PUT
Updates the footer content or sets it as default.
ops
DELETE
Permanently removes the footer.
ops
GET
Retrieves all messages.
vendor, client, ops
GET
Get a message by id.
vendor, client, ops
GET
Gets a list of subscribers.
vendor, client, ops
GET
Gets subscriber details.
vendor, client, ops
PUT
Modifies recipients of a given configuration.
vendor, client, ops
POST
Disables the category for the account.
vendor, client, ops
POST
Enables the category for the account.
vendor, client, ops
GET
Returns contacts configured to receive notifications for the given account and category.
vendor, ops
GET
Gets a list of template.
vendor, ops
POST
Creates a new template.
vendor, ops
GET
Gets template details.
vendor, ops
PUT
Updates template properties. Only speciic fields can be modified.
vendor, ops
DELETE
Permanently removes the template and all its language variants
vendor, ops
POST
Activates the template, making it available for sending notifications.
vendor, ops
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
The Subscriber object manages the configuration of notifications for accounts.
It serves as the link between an account and a notification category, storing details about whether that category is enabled for the account and identifying the recipients who should receive notifications for it.
This object contains the following attributes:
id
string, core
(Read-only) The primary identifier for the notification subscriber.
href
string, core
(Read-only) A relative reference to the object.
name
string, core
(Read-only) The name of the category.
status
enum, core
Indicates if the category is enabled or disabled. If disabled, no notifications are sent for the category.
note
string
Notes related to the category.
recipients
recipients
The recipient of the notification email. To receive a notification, the user must be in the recipients.users or be a part of a group within recipients.userGroups.
Example:
account
object, core
(Read-only) Represents the object.
category
object, core
(Read-only) Represents the object.
audit
object
(Read-only) Represents the object.
{
"id": "NTS-1111-2222-1234",
"href": "/notifications/subscribers/NTS-1111-2222-1234",
"status": "Enabled",
"category": {
"id": "NTC-1234-9876",
"href": "/v1/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Includes updates about order confirmations, order status updates, and related communications."
},
"account": {
"id": "AC-1111-2222",
"href": "/accounts/accounts/AC-1111-2222",
"type": "Client",
"status": "Active",
"name": "Agroasemex test copy 2",
"icon": "/v1/accounts/accounts/AC-1111-2222/icon"
},
"recipients": {
"users": [
{
"id": "USR-0000-0001",
"href": "/accounts/users/USR-0000-0001",
"name": "Will Smith"
}
],
"userGroups": [
{
"id": "UGR-2459-0365",
"href": "/accounts/user-groups/UGR-2459-0365",
"name": "Administrators",
"description": "Manages administrative tasks and resources within an organization.",
"isDefault": true
}
]
},
"audit": {
"created": {
"at": "2023-12-15T10:17:11.179Z",
"by": {
"id": "USR-0000-0001",
"href": "/accounts/users/USR-0000-0001",
"name": "Will Smith"
}
},
"updated": {
"at": "2023-12-15T10:17:11.179Z",
"by": {
"id": "USR-0000-0001",
"href": "/accounts/users/USR-0000-0001",
"name": "Will Smith"
}
}
}
}{
"recipients": {
"users": [],
"userGroups": []
}
}Draft
The template variant is currently in draft and not ready for use.
Active
The template variant is active and can be used.
This object contains the following attributes:
This object contains the following attributes:
Disabled
The template variant has been disabled temporarily. Disabled template variants can be reactivated as necessary.
Deleted
The template variant has been deleted.
id
string
A unique identifier for the footer.
id
string
The primary identifier of the object.
languageCode
string
Indicates the language of the footer content.
content
string
The content of the footer.
isDeleted
bool
Indicates whether this version is deleted.
isDefault
bool
Indicates whether the version is a default one.
audit
object
Represents the audit object.
name
string
The name of the template.
description
string
A description of the template.
category
object
Represents the category linked to the template.
object type
string
The object type linked to the template.
status
string
The status of the template.
statistics
statistics
Usage data of the template (today, this week, and this month).
audit
object
Represents the audit object.
The Category object represents a category for notifications. Emails are sent within specific categories. Operations administrators can disable email sending for certain categories. User-level opt-outs are also managed through these categories.
This object contains the following attributes:
id
string, core
(Read-only) The primary identifier for the category.
href
string, core
(Read-only) A relative reference to the object.
name
string, core
The name of the category.
shortDescription
string, core
A short description of the category. The description is displayed in the notification settings view for contacts.
description
string
A detailed description of the category. It describes the overall purpose of this category and can be used to include links to the documentation.
status
enum
The status of the category. Only published categories are visible to clients and vendors.
note
string
Notes to unpublish a category.
optOutAllowed
bool
Indicates if a contact can disable a notification category.
statistics
object
(Read-only) Statistics indicating how many messages of a given category were sent today, this week, and this month.
Example:
audit
object
(Read-only) Represents the object.
{
"id": "NTC-1234-9876",
"href": "/v1/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Includes updates about order confirmations, order status updates, and related communications.",
"description": "This category is used by the platform to provide notifications regarding\nOrders updates when a new Order is created, an existing\nOrder is updated or validation failed.",
"status": "Published",
"optOutAllowed": "true",
"statistics": {
"messagesSent":
{
"today": 22,
"currentWeek": 244,
"currentMonth": 668
}
},
"audit": {
"created": {
"at": "2023-12-14T17:28:57Z",
"by": {
"id": "UR-1234-1234-1234",
"name": "John Smith",
"icon": "/static/users/UR-1234-1234-1234.icon.svg"
},
"of": {
"id": "ACC-1234-1234",
"href": "/accounts/accounts/ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}
}
}{
"messagesSent":
{
"today": 22,
"currentWeek": 244,
"currentMonth": 668
}
}The Message object represents a single notification that was sent to a single contact.
This object contains the following attributes:
id
string, core
(Read-only) The primary identifier of the message.
href
string, core
(Read-only) A relative reference to the object.
batch
object, core
(Read-only) Represents the batch associated with the message.
contact
object, core
Represents the contact object.
account
object
Represents the account object.
status
enum, core
The status of the notification message. Allowed values are:
Queued
Sent
Bounced
Complained
Discarded
subject
string, core
The subject line of the message.
category
object, core
Represents the category object.
body
Represents the body text.
attachments
object
(Read-only) Represents the attachment object.
Example:
audit
object
(Read-only) Represents the audit object.
[
{
"id": "ATT-1234-1234-1234",
"name": "Some mail attachment",
"contentType": "application/octet-stream",
"fileSize": 1234,
"fileName": "SomeFile.pdf",
"href": "/v1/notifications/messages/attachments/ATT-1234-1234-1234"
},
{
"id": "ATT-9876-9876-9876",
"name": "Some other mail attachment",
"contentType": "application/octet-stream",
"fileSize": 9876,
"fileName": "SomeOtherFile.pdf",
"href": "/v1/notifications/messages/attachments/ATT-9876-9876-9876"
}
]{
"id": "MSG-1234-9876-4442-4314",
"href": "/v1/notifications/messages/MSG-1234-9876-4442-4314",
"batch": {
"id": "MST-1234-9876-3333"
},
"contact": {
"id": "CTT-1234-9876-1234",
"href": "/v1/notifications/contacts/CTT-1234-9876-1234",
"name": "Will Smith",
"email": "will.smith@softwareone.com",
"user": {
"id": "USR-3773-5838",
"href": "/accounts/users/USR-1234-9876",
"name": "Will Smith",
"email": "will.smith@softwareone.com"
}
},
"account": {
"id": "ACC-1671-0642",
"href": "/accounts/accounts/ACC-1671-0642",
"type": "Client",
"status": "Enabled",
"name": "You Are a Test Account",
"logo": "/accounts/accounts/ACC-1671-0642/logo.png"
},
"status": "Sent",
"subject": "Check out the new service offering",
"body": "<html><body><b>Hello</b></body></html>",
"category": {
"id": "NTC-1234-9876",
"href": "/v1/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Includes updates about order confirmations, order status updates, and related communications."
},
"audit": {
"created": {
"at": "2023-12-14T17:28:57Z",
"by": {
"id": "UR-1234-1234-1234",
"name": "John Smith",
"icon": "/static/users/UR-1234-1234-1234.icon.svg"
},
"of": {
"id": "ACC-1234-1234",
"href": "/accounts/accounts/ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}
}
}The Batch object represents an email being sent to a specific category and multiple contacts.
This object contains the following attributes:
id
string, core
(Read-only) A primary identifier for the batch.
href
string, core
(Read-only) A relative reference to the object.
category
object, core
Represents the object.
account
object, core
Represents the object.
subject
string, core
The subject line of the notification email.
body
string
The body of the message.
attachments
object
(Read-only) Represents the attachment object. Example:
{
"id": "MST-1234-9876-3333",
"href": "/v1/notifications/batches/MST-1234-9876-3333",
"category": {
"id": "NTC-1234-9876",
"href": "/v1/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Includes updates about order confirmations, order status updates, and related communications."
},
"account": {
"id": "ACC-5131-0044",
"href": "/accounts/accounts/ACC-5131-0044",
"type": "Client",
"status": "Active",
"name": "SURFMARKET BV"
},
"subject": "Order published",
"body": "<b>Hello</b>",
}[
{
"id": "ATT-1234-1234-1234",
"name": "Some mail attachment",
"contentType": "application/octet-stream",
"fileSize": 1234,
"fileName": "SomeFile.pdf",
"href": "/v1/notifications/messages/attachments/ATT-1234-1234-1234"
},
{
"id": "ATT-9876-9876-9876",
"name": "Some other mail attachment",
"contentType": "application/octet-stream",
"fileSize": 9876,
"fileName": "SomeOtherFile.pdf",
"href": "/v1/notifications/messages/attachments/ATT-9876-9876-9876"
}
]
The category has been published and is visible on the platform. When a category is created, it is automatically set to the published state. By default, it is enabled for everyone. Users can disable the category in their notification settings if they choose to do so.
Unpublished
The category has been published and is visible on the platform. However, a Notification Category in this state cannot be used and is therefore not visible on the platform. An unpublished category can be revived and changed back to a published state.
Deleted
The category has been deleted. When a category is deleted, all configurations for that category across all accounts are also removed.
Id of webhook to be deleted
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/notifications/webhooks/{id}/enable HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Permanently removes the category. This operation is only allowed if DeleteAllowed is true.
The category ID.
No Content
No content
Bad Request
Not Found
DELETE /public/v1/notifications/categories/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Permanently removes the contact and all associated subscriptions. This operation cannot be undone.
The Contact ID.
No Content
No content
Bad Request
Not Found
DELETE /public/v1/notifications/contacts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Represents a notification category that can be used to organize and filter notifications.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Not Found
GET /public/v1/notifications/categories/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}Publishes the category, making it available for subscriptions. Contacts can then subscribe to it.
The category ID.
Entity Note Dto
OK
Represents a notification category that can be used to organize and filter notifications.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
Not Found
POST /public/v1/notifications/categories/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"note": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}Blocks the contact, preventing them from receiving any notifications until unblocked.
The Contact ID.
OK
Represents a notification contact who can receive email notifications.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Bad Request
POST /public/v1/notifications/contacts/{id}/block HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
}Supports RQL filtering, sorting, and pagination via query string parameters.
OK
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Bad Request
GET /public/v1/notifications/contacts HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
}
]
}Creates a new contact with the provided email address. Contacts can then be subscribed to categories.
Created
Represents a notification contact who can receive email notifications.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Bad Request
POST /public/v1/notifications/contacts HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"email": "text",
"optOuts": [
{
"id": "text"
}
],
"name": "text",
"directories": [
{
"id": "text"
}
],
"chat": true
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
}Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.
The resource ID.
Optional RQL select statement to filter fields.
OK
Represents a subscription that defines which users or user groups should automatically receive notifications for a specific category.
Gets or initializes the current status of the subscriber.
Gets or initializes an optional note about this subscriber.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
Not Found
GET /public/v1/notifications/subscribers/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"status": "text",
"note": "text",
"recipients": {
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
],
"userGroups": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"modules": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
],
"obsolete": true,
"eligibility": {
"multi": true,
"single": true
}
}
}
],
"logo": "text",
"isDefault": true,
"users": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
],
"extensions": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"status": "Draft"
}
],
"buyers": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
]
}
]
},
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}
}Id of webhook to be deleted
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/notifications/webhooks/{id}/disable HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
RQL select statements
OK
No content
Created
No content
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/notifications/webhooks HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Updates contact properties. Only provided fields will be modified.
The Contact ID.
OK
Represents a notification contact who can receive email notifications.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Bad Request
PUT /public/v1/notifications/contacts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"email": "text",
"optOuts": [
{
"id": "text"
}
],
"name": "text",
"directories": [
{
"id": "text"
}
],
"chat": true
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
}OK
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
GET /public/v1/notifications/categories HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}
]
}OK
Not Found
GET /public/v1/notifications/webhooks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"url": "text",
"description": "text",
"status": "Enabled",
"type": "ValidatePurchaseOrderDraft",
"secret": "text",
"statistics": {
"total": 1,
"successes": 1,
"failures": 1,
"failuresSinceLastSuccess": 1
},
"objectType": "Order",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"object": {
"id": "text",
"name": "text",
"icon": "text"
},
"criteria": [
{
"key": "text",
"value": "text"
}
],
"lastSuccess": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastFailure": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastCall": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
}
}Enables the subscriber, allowing notifications to be sent to configured recipients.
The Subscriber ID.
OK
Represents a subscription that defines which users or user groups should automatically receive notifications for a specific category.
Gets or initializes the current status of the subscriber.
Gets or initializes an optional note about this subscriber.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
Not Found
POST /public/v1/notifications/subscribers/{id}/enable HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"note": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"status": "text",
"note": "text",
"recipients": {
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
],
"userGroups": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"modules": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
],
"obsolete": true,
"eligibility": {
"multi": true,
"single": true
}
}
}
],
"logo": "text",
"isDefault": true,
"users": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
],
"extensions": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"status": "Draft"
}
],
"buyers": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
]
}
]
},
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}
}Unpublishes the category, making it unavailable for new subscriptions. Existing subscriptions are not affected.
The category ID.
Entity Note Dto
OK
Represents a notification category that can be used to organize and filter notifications.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
Not Found
POST /public/v1/notifications/categories/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"note": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}Supports RQL filtering, sorting, and pagination via query string parameters.
OK
Gets or sets the unique identifier for the attachment.
Gets the URL to download the attachment.
Gets or sets the display name for the attachment.
Gets or sets the file name of the attachment.
Gets or sets the size of the attachment in bytes.
Gets or sets the content type of the attachment.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Gets or sets the current status of the batch.
Gets or sets the type of batch.
Gets or sets the body content of the message.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the reason the message was discarded, if applicable.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the current status of the template.
Gets or sets the current status of the message.
Gets or sets the reason for the current status.
Gets or sets the subject of the message.
Bad Request
GET /public/v1/notifications/messages HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"queued": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"discarded": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"sent": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"bounced": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"complained": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"attachments": [
{
"id": "text",
"href": "text",
"name": "text",
"fileName": "text",
"fileSize": 1,
"contentType": "text"
}
],
"batch": {
"id": "text",
"revision": 1,
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
},
"template": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
},
"status": "text",
"type": "text"
},
"body": "text",
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
},
"contact": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
},
"template": {
"id": "text",
"name": "text",
"revision": 1,
"lastUsed": "2026-01-01T00:00:00.000Z",
"status": "text"
},
"status": "text",
"statusReason": "text",
"subject": "text"
}
]
}Id of webhook to be deleted
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/notifications/webhooks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.
The resource ID.
Optional RQL select statement to filter fields.
OK
Represents a notification contact who can receive email notifications.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Bad Request
Not Found
GET /public/v1/notifications/contacts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
}Supports RQL filtering, sorting, and pagination via query string parameters.
OK
Gets or sets the unique identifier for the attachment.
Gets the URL to download the attachment.
Gets or sets the display name for the attachment.
Gets or sets the file name of the attachment.
Gets or sets the size of the attachment in bytes.
Gets or sets the content type of the attachment.
Gets or sets the body content for messages in this batch.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Gets or sets the number of messages that bounced.
Gets or sets the number of messages that received complaints.
Gets or sets the number of messages that were discarded before sending.
Gets or sets the number of messages that failed to send.
Gets or sets the number of messages currently queued for sending.
Gets or sets the number of messages that were successfully sent.
Gets or sets the total number of messages in the batch.
Gets or sets the subject for messages in this batch.
Gets or sets the current status of the batch.
Gets or sets the reason for the current status of the batch.
Gets or sets the type of batch.
Gets or sets the payload data used for template-based batches.
Gets or sets the send context of the batch.
Bad Request
GET /public/v1/notifications/batches HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"processed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"attachments": [
{
"id": "text",
"href": "text",
"name": "text",
"fileName": "text",
"fileSize": 1,
"contentType": "text"
}
],
"body": "text",
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
},
"template": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
},
"statistics": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"queued": 1,
"sent": 1,
"total": 1
},
"subject": "text",
"status": "text",
"statusReason": "text",
"type": "text",
"payload": "text",
"sendContext": "text",
"sourceAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
]
}Disables the subscriber, preventing notifications from being sent to recipients.
The Subscriber ID.
OK
Represents a subscription that defines which users or user groups should automatically receive notifications for a specific category.
Gets or initializes the current status of the subscriber.
Gets or initializes an optional note about this subscriber.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
Not Found
POST /public/v1/notifications/subscribers/{id}/disable HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"note": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"status": "text",
"note": "text",
"recipients": {
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
],
"userGroups": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"modules": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
],
"obsolete": true,
"eligibility": {
"multi": true,
"single": true
}
}
}
],
"logo": "text",
"isDefault": true,
"users": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
],
"extensions": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"status": "Draft"
}
],
"buyers": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
]
}
]
},
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}
}OK
GET /public/v1/notifications/webhooks HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"url": "text",
"description": "text",
"status": "Enabled",
"type": "ValidatePurchaseOrderDraft",
"secret": "text",
"statistics": {
"total": 1,
"successes": 1,
"failures": 1,
"failuresSinceLastSuccess": 1
},
"objectType": "Order",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"object": {
"id": "text",
"name": "text",
"icon": "text"
},
"criteria": [
{
"key": "text",
"value": "text"
}
],
"lastSuccess": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastFailure": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastCall": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
}
}
]
}Updates category properties. Only provided fields will be modified.
The category ID.
Created
Represents a notification category that can be used to organize and filter notifications.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
Not Found
PUT /public/v1/notifications/categories/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"name": "text",
"description": "text",
"optOutAllowed": true,
"note": "text",
"deleteAllowed": true,
"enabledByDefault": true
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}Unblocks the contact, allowing them to receive notifications again.
The Contact ID.
OK
Represents a notification contact who can receive email notifications.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Bad Request
POST /public/v1/notifications/contacts/{id}/unblock HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
}Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.
The resource ID.
Optional RQL select statement to filter fields.
OK
Represents a batch of notification messages that share common properties.
Gets or sets the unique identifier for the attachment.
Gets the URL to download the attachment.
Gets or sets the display name for the attachment.
Gets or sets the file name of the attachment.
Gets or sets the size of the attachment in bytes.
Gets or sets the content type of the attachment.
Gets or sets the body content for messages in this batch.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Gets or sets the number of messages that bounced.
Gets or sets the number of messages that received complaints.
Gets or sets the number of messages that were discarded before sending.
Gets or sets the number of messages that failed to send.
Gets or sets the number of messages currently queued for sending.
Gets or sets the number of messages that were successfully sent.
Gets or sets the total number of messages in the batch.
Gets or sets the subject for messages in this batch.
Gets or sets the current status of the batch.
Gets or sets the reason for the current status of the batch.
Gets or sets the type of batch.
Gets or sets the payload data used for template-based batches.
Gets or sets the send context of the batch.
Bad Request
Not Found
GET /public/v1/notifications/batches/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"processed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"attachments": [
{
"id": "text",
"href": "text",
"name": "text",
"fileName": "text",
"fileSize": 1,
"contentType": "text"
}
],
"body": "text",
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
},
"template": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
},
"statistics": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"queued": 1,
"sent": 1,
"total": 1
},
"subject": "text",
"status": "text",
"statusReason": "text",
"type": "text",
"payload": "text",
"sendContext": "text",
"sourceAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}Returns the attachment metadata. Use Accept header to control response format.
The batch ID.
The attachment ID.
OK
Represents a file attachment associated with a notification message or batch.
Gets or sets the unique identifier for the attachment.
Gets the URL to download the attachment.
Gets or sets the display name for the attachment.
Gets or sets the file name of the attachment.
Gets or sets the size of the attachment in bytes.
Gets or sets the content type of the attachment.
Moved Permanently
No content
GET /public/v1/notifications/batches/{batchId}/attachments/{attachmentId} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"href": "text",
"name": "text",
"fileName": "text",
"fileSize": 1,
"contentType": "text"
}Creates a new notification category. The category is created in unpublished state. Publish the category to make it available for subscriptions.
CreateCategoryDto
Created
Represents a notification category that can be used to organize and filter notifications.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
POST /public/v1/notifications/categories HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"name": "text",
"description": "text",
"optOutAllowed": true,
"note": "text",
"deleteAllowed": true,
"enabledByDefault": true
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}Modifies the recipients (users and user groups) for the subscriber. Only provided fields will be modified.
The Subscriber ID.
OK
Represents a subscription that defines which users or user groups should automatically receive notifications for a specific category.
Gets or initializes the current status of the subscriber.
Gets or initializes an optional note about this subscriber.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
Not Found
PUT /public/v1/notifications/subscribers/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 203
{
"recipients": {
"users": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
],
"userGroups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
]
},
"note": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"status": "text",
"note": "text",
"recipients": {
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
],
"userGroups": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"modules": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
],
"obsolete": true,
"eligibility": {
"multi": true,
"single": true
}
}
}
],
"logo": "text",
"isDefault": true,
"users": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
],
"extensions": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"status": "Draft"
}
],
"buyers": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
]
}
]
},
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}
}Creates and queues a batch of raw messages with file attachments. Use multipart/form-data content type to include files.
Created
Represents a batch of notification messages that share common properties.
Gets or sets the unique identifier for the attachment.
Gets the URL to download the attachment.
Gets or sets the display name for the attachment.
Gets or sets the file name of the attachment.
Gets or sets the size of the attachment in bytes.
Gets or sets the content type of the attachment.
Gets or sets the body content for messages in this batch.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Gets or sets the number of messages that bounced.
Gets or sets the number of messages that received complaints.
Gets or sets the number of messages that were discarded before sending.
Gets or sets the number of messages that failed to send.
Gets or sets the number of messages currently queued for sending.
Gets or sets the number of messages that were successfully sent.
Gets or sets the total number of messages in the batch.
Gets or sets the subject for messages in this batch.
Gets or sets the current status of the batch.
Gets or sets the reason for the current status of the batch.
Gets or sets the type of batch.
Gets or sets the payload data used for template-based batches.
Gets or sets the send context of the batch.
Bad Request
POST /public/v1/notifications/batches HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 399
{
"batch": {
"content": {
"templated": {
"template": {
"id": "text",
"externalId": "text",
"languageCode": "text"
},
"data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"test": true
},
"raw": {
"category": {
"id": "text"
},
"subject": "text",
"body": "text"
}
},
"recipients": {
"account": {
"id": "text"
},
"buyer": {
"id": "text",
"externalIds": {
"erpCustomerId": "text"
}
},
"user": {
"id": "text"
},
"contacts": [
{
"id": "text",
"email": "text"
}
]
}
},
"form": {}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"processed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"attachments": [
{
"id": "text",
"href": "text",
"name": "text",
"fileName": "text",
"fileSize": 1,
"contentType": "text"
}
],
"body": "text",
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
},
"template": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
},
"statistics": {
"bounced": 1,
"complained": 1,
"discarded": 1,
"failed": 1,
"queued": 1,
"sent": 1,
"total": 1
},
"subject": "text",
"status": "text",
"statusReason": "text",
"type": "text",
"payload": "text",
"sendContext": "text",
"sourceAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.
The resource ID.
Optional RQL select statement to filter fields.
OK
Represents an individual notification message sent to a specific contact.
Gets or sets the unique identifier for the attachment.
Gets the URL to download the attachment.
Gets or sets the display name for the attachment.
Gets or sets the file name of the attachment.
Gets or sets the size of the attachment in bytes.
Gets or sets the content type of the attachment.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Gets or sets the current status of the batch.
Gets or sets the type of batch.
Gets or sets the body content of the message.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the reason the message was discarded, if applicable.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the current status of the template.
Gets or sets the current status of the message.
Gets or sets the reason for the current status.
Gets or sets the subject of the message.
Bad Request
Not Found
GET /public/v1/notifications/messages/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"queued": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"discarded": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"sent": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"bounced": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"complained": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"attachments": [
{
"id": "text",
"href": "text",
"name": "text",
"fileName": "text",
"fileSize": 1,
"contentType": "text"
}
],
"batch": {
"id": "text",
"revision": 1,
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
},
"template": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
},
"status": "text",
"type": "text"
},
"body": "text",
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
},
"contact": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
},
"template": {
"id": "text",
"name": "text",
"revision": 1,
"lastUsed": "2026-01-01T00:00:00.000Z",
"status": "text"
},
"status": "text",
"statusReason": "text",
"subject": "text"
}Id of webhook to update
RQL select statements
OK
Forbidden
Not Found
Internal Server Error
No content
PUT /public/v1/notifications/webhooks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 417
{
"webhookId": "text",
"description": {
"value": "text"
},
"url": {
"value": "https://example.com"
},
"criteria": {
"value": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"secret": {
"value": "text"
},
"lastCall": {
"value": {
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"httpStatusCode": "Continue",
"reasonPhrase": "text",
"success": true,
"response": "text",
"error": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"url": "text",
"description": "text",
"status": "Enabled",
"type": "ValidatePurchaseOrderDraft",
"secret": "text",
"statistics": {
"total": 1,
"successes": 1,
"failures": 1,
"failuresSinceLastSuccess": 1
},
"objectType": "Order",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"object": {
"id": "text",
"name": "text",
"icon": "text"
},
"criteria": [
{
"key": "text",
"value": "text"
}
],
"lastSuccess": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastFailure": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastCall": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
}
}Returns contacts configured to receive notifications when all conditions are met: the category is published, the subscriber is enabled, and the user is set as a recipient. Use filter(group.buyers.id,BUY-XXXX) to filter by buyer visibility.
The Account ID.
The Category ID.
OK
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Bad Request
GET /public/v1/notifications/accounts/{accountId}/categories/{categoryId}/contacts HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"blocked": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"blockedReason": "text",
"email": "text",
"status": "text",
"identity": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1
},
"directories": [
{
"id": "text",
"revision": 1
}
],
"chat": true,
"optOuts": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
}
],
"user": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
}
]
}This object contains the following attributes:
id
string
The primary identifier of the object.
languageCode
string
The language of the template variant.
subject
string
The subject line of the template variant.
body
string
The content of the template variant with placeholders.
default
boolean
Indicates whether the template is the default.
status
enum
Indicates the status of the template variant.
audit
object
Represents the object.
Permanently removes the language variant from the template. This operation cannot be undone.
A notification template ID.
A template variant ID.
No Content
No content
Not Found
DELETE /public/v1/notifications/templates/{templateId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Permanently removes the template and all its language variants. This operation cannot be undone.
A notification template ID.
No Content
No content
Not Found
DELETE /public/v1/notifications/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Permanently removes the footer. This operation cannot be undone.
The footer ID.
No Content
No content
Bad Request
Not Found
DELETE /public/v1/notifications/footers/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Updates footer content or sets it as default. Only provided fields will be modified. The language code cannot be changed.
The footer ID.
OK
Represents a localized footer template that can be appended to notification messages.
Gets or sets the language code for this footer.
Gets or sets the content of the footer.
Gets or sets a value indicating whether this is the default footer.
Gets or sets the current status of the footer.
Bad Request
Not Found
PUT /public/v1/notifications/footers/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"content": "text",
"isDefault": true
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"languageCode": "text",
"content": "text",
"isDefault": true,
"status": "text"
}OK
Gets or sets the body content for this variant.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the current status of the template.
Gets or sets the current status of the variant.
Gets or sets the subject for messages created from this variant.
GET /public/v1/notifications/templates/{templateId}/variants HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"body": "text",
"default": true,
"languageCode": "text",
"template": {
"id": "text",
"name": "text",
"revision": 1,
"lastUsed": "2026-01-01T00:00:00.000Z",
"status": "text"
},
"status": "text",
"subject": "text"
}
]
}OK
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
GET /public/v1/notifications/templates HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
}
]
}Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.
The resource ID.
Optional RQL select statement to filter fields.
OK
Represents a localized footer template that can be appended to notification messages.
Gets or sets the language code for this footer.
Gets or sets the content of the footer.
Gets or sets a value indicating whether this is the default footer.
Gets or sets the current status of the footer.
Bad Request
Not Found
GET /public/v1/notifications/footers/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"languageCode": "text",
"content": "text",
"isDefault": true,
"status": "text"
}OK
Represents a language-specific variant of a template.
Gets or sets the body content for this variant.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the current status of the template.
Gets or sets the current status of the variant.
Gets or sets the subject for messages created from this variant.
Not Found
GET /public/v1/notifications/templates/{templateId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"body": "text",
"default": true,
"languageCode": "text",
"template": {
"id": "text",
"name": "text",
"revision": 1,
"lastUsed": "2026-01-01T00:00:00.000Z",
"status": "text"
},
"status": "text",
"subject": "text"
}Creates a new notification template in draft state. Add language variants and activate before use.
Created
Represents a reusable template that can be used to generate messages.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Bad Request
Not Found
POST /public/v1/notifications/templates HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 232
{
"name": "text",
"description": "text",
"category": {
"id": "text"
},
"criteria": {
"accountTypes": [
"Client"
],
"objectType": "Account",
"filterCondition": "text",
"recipients": {
"selector": "text"
}
},
"externalId": "text",
"defaultVariant": {
"id": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
}Adds a new language variant to the template with subject and body content for the specified language.
A notification template ID.
Created
Represents a language-specific variant of a template.
Gets or sets the body content for this variant.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the current status of the template.
Gets or sets the current status of the variant.
Gets or sets the subject for messages created from this variant.
Bad Request
Not Found
POST /public/v1/notifications/templates/{templateId}/variants HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"languageCode": "text",
"subject": "text",
"body": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"body": "text",
"default": true,
"languageCode": "text",
"template": {
"id": "text",
"name": "text",
"revision": 1,
"lastUsed": "2026-01-01T00:00:00.000Z",
"status": "text"
},
"status": "text",
"subject": "text"
}OK
Represents a reusable template that can be used to generate messages.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Not Found
GET /public/v1/notifications/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
}Supports RQL filtering, sorting, and pagination via query string parameters.
OK
Gets or sets the language code for this footer.
Gets or sets the content of the footer.
Gets or sets a value indicating whether this is the default footer.
Gets or sets the current status of the footer.
Bad Request
GET /public/v1/notifications/footers HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"languageCode": "text",
"content": "text",
"isDefault": true,
"status": "text"
}
]
}Activates the template, making it available for sending notifications. Only active templates can be used.
A notification template ID.
OK
Represents a reusable template that can be used to generate messages.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Not Found
POST /public/v1/notifications/templates/{id}/activate HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
}Creates a new footer for the specified language code with the provided content.
Created
Represents a localized footer template that can be appended to notification messages.
Gets or sets the language code for this footer.
Gets or sets the content of the footer.
Gets or sets a value indicating whether this is the default footer.
Gets or sets the current status of the footer.
Bad Request
POST /public/v1/notifications/footers HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"languageCode": "text",
"content": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"languageCode": "text",
"content": "text",
"isDefault": true,
"status": "text"
}Updates the subject and/or body content of the language variant. Only provided fields will be modified.
A notification template ID.
A template variant ID.
OK
Represents a language-specific variant of a template.
Gets or sets the body content for this variant.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the current status of the template.
Gets or sets the current status of the variant.
Gets or sets the subject for messages created from this variant.
Bad Request
Not Found
PUT /public/v1/notifications/templates/{templateId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"languageCode": "text",
"subject": "text",
"body": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"body": "text",
"default": true,
"languageCode": "text",
"template": {
"id": "text",
"name": "text",
"revision": 1,
"lastUsed": "2026-01-01T00:00:00.000Z",
"status": "text"
},
"status": "text",
"subject": "text"
}Updates template properties. Only provided fields will be modified.
A notification template ID.
OK
Represents a reusable template that can be used to generate messages.
Gets or sets the description of the category.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets the list of account types for which this template should trigger.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets the platform object type this template monitors.
Gets or sets the RQL filter condition that must be satisfied for the template to trigger.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets the description of this template.
Gets or sets the timestamp of when this template was last used to send a notification.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the current status of the template.
Gets or sets a value indicating whether this is the default variant for the parent template.
Gets or sets the language code for this variant.
Gets or sets the current status of the variant.
Gets or sets an external identifier for integration with external systems.
Bad Request
Not Found
PUT /public/v1/notifications/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 232
{
"name": "text",
"description": "text",
"category": {
"id": "text"
},
"criteria": {
"accountTypes": [
"Client"
],
"objectType": "Account",
"filterCondition": "text",
"recipients": {
"selector": "text"
}
},
"externalId": "text",
"defaultVariant": {
"id": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"category": {
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z"
},
"criteria": {
"accountTypes": [
"text"
],
"filterCondition": "text",
"objectType": "text",
"recipients": {
"selector": "text"
}
},
"defaultVariant": {
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
},
"description": "text",
"lastUsed": "2026-01-01T00:00:00.000Z",
"owner": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"status": "text",
"variants": [
{
"id": "text",
"revision": 1,
"default": true,
"languageCode": "text",
"status": "text"
}
],
"externalId": "text"
}Supports RQL filtering, sorting, and pagination via query string parameters.
OK
Gets or initializes the current status of the subscriber.
Gets or initializes an optional note about this subscriber.
Gets or sets the description of the category.
Gets or sets a value indicating whether recipients can opt out of notifications in this category.
Gets or sets the current status of the category.
Gets or sets an optional note about the category.
Gets or sets a value indicating whether this category can be deleted.
Gets or sets the number of messages sent in the current month.
Gets or sets the number of messages sent today.
Gets or sets the number of messages sent in the current week.
Gets or sets the timestamp of when this category was last used to send a notification.
Gets or sets a value indicating whether this category is enabled by default for new recipients.
Bad Request
GET /public/v1/notifications/subscribers HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"disabled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"status": "text",
"note": "text",
"recipients": {
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"lastLoginAt": "2026-01-01T00:00:00.000Z",
"settings": {
"cultureCode": "text",
"dateFormat": "text",
"languageCode": "text",
"numberFormat": {
"decimalSeparator": "text",
"groupSeparator": "text"
},
"timeFormat": "text",
"timeZone": "text",
"optOuts": {
"objectTypes": [
"text"
]
}
},
"accounts": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
],
"currentAccount": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
],
"userGroups": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"modules": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
],
"obsolete": true,
"eligibility": {
"multi": true,
"single": true
}
}
}
],
"logo": "text",
"isDefault": true,
"users": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
],
"extensions": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"status": "Draft"
}
],
"buyers": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
]
}
]
},
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"category": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"optOutAllowed": true,
"status": "text",
"note": "text",
"deleteAllowed": true,
"statistics": {
"month": 1,
"today": 1,
"week": 1
},
"lastUsed": "2026-01-01T00:00:00.000Z",
"enabledByDefault": true
}
}
]
}The Contact object represents a contact who receives the notifications. Contact can be linked to a user in the platform. Each contact can manage its notification preferences at the category level.
This object contains the following attributes:
id
string, core
(Read-only) A primary identifier for the contact.
href
string, core
(Read-only) A relative reference to the object.
name
string, core
The display name of the contact.
email
string, core
The email address of the contact.
user
object, core
(Read-only) Indicates if the email belongs to a registered on the platform.
Example:
optOuts
object
Represents the object, containing the list of notification categories the contact has chosen to opt out of. By default, a contact is opted into all published categories.
Example:
status
enum
Indicates the status. Allowed values are active
or blocked.
audit
object
(Read-only) Represents the object.
{
"id": "CTT-1234-9876-1234",
"href": "/v1/notifications/contacts/CTT-1234-9876-1234",
"name": "Will Smith",
"email": "will.smith@softwareone.com",
"user": {
"id": "USR-3773-5838",
"href": "/accounts/users/USR-1234-9876",
"name": "Will Smith",
"email": "will.smith@softwareone.com"
},
"optOuts": [
{
"id": "NTC-1234-9876",
"href": "/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Orders"
}
],
"status": "Active",
"audit": {
"created": {
"at": "2023-12-14T17:28:57Z",
"by": {
"id": "UR-1234-1234-1234",
"name": "John Smith",
"icon": "/static/users/UR-1234-1234-1234.icon.svg"
},
"of": {
"id": "ACC-1234-1234",
"href": "/accounts/accounts/ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}
}
}{
"id": "USR-3773-5838",
"href": "/accounts/users/USR-1234-9876",
"name": "Will Smith",
"email": "will.smith@softwareone.com"
}[
{
"id": "NTC-1234-9876",
"href": "/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Orders"
}
]