How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adobe Suite Alert Subscriptions API

Alert subscriptions allow you to receive notifications on the different statuses of both ad hoc and scheduled queries. Alerts can be received by email, within the Platform UI, or both.

Adobe Suite Alert Subscriptions API is one of 482 APIs that Adobe Suite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alert Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, pricing, release notes, and a getting-started guide.

This API exposes 7 operations across 4 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, //{environment}.adobe.io/data/foundation/query.

7 operations 4 paths 41 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://image.adobe.io
Resource Areas
1

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Alert Subscriptions 7

Alert subscriptions allow you to receive notifications on the different statuses of both ad hoc and scheduled queries. Alerts can be received by email, within the Platform UI, or…

GET
/alert-subscriptions
List alerts
listAlertsPerImsOrgAndSandbox 10 params → 200401500
POST
/alert-subscriptions
Create an alert and subscribe users
createAndSubscribeToAnAlert 7 params body → 200400401404500
GET
/alert-subscriptions/{assetId}
List alert subscription information for a query or schedule
listSubscribersForAnAlertByAssetsId 7 params → 200401404500
GET
/alert-subscriptions/{assetId}/{alertType}
List alert subscription information for a particular query and alert type
listSubscribersForAnAlertByAssetIdAndAlertType 8 params → 200400401404500
DELETE
/alert-subscriptions/{assetId}/{alertType}
Delete the alert for a particular query and alert type
deleteAlert 8 params → 200400401404500
PATCH
/alert-subscriptions/{assetId}/{alertType}
Enable or disable an alert
patchAlert 8 params body → 200400401404500
GET
/alert-subscriptions/user-subscriptions/{emailID}
List information on all alerts that a user is subscribed to
listAllAlertsSubscribedToByEmailId 11 params → 200400401500

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are PagingProperties (5 properties), alert_links (5 properties), alert_subscription_response_body (5 properties), CoreAlertProperties (4 properties). Each schema is shown below with its type and property counts.

subscribers_for_alert_by_assetId
object
Alert information and Email IDs for all users subscribed for alerts on a particular query.
1 property
AlertId
string
The alert name that appears in the Alerts tab of the Adobe Experience Platform UI.
post_bad_request_error_message
object
The error response for a 400 status for a request to create and subscribe to a new alert.
2 properties
BadRequestError
object
An HTTP status code that indicates the server cannot or will not process the request due to something that is perceived to be a client error.
AlertName
string
The name of the alert. This name is generated automatically by Adobe Experience Platform.
AssetId
string
The query or schedule ID that the alert is created for and subscribed to.
alert_patched_not_found_error_message
object
The error response for a 404 status to patch an alert.
2 properties
query_list_links
object
Contains the URI reference that clients may use to obtain the next or previous page of resources.
2 properties
CoreAlertProperties
object
Contains properties to describe the query ID, alert ID, type, and status of alert.
4 properties
Id
string
The alert name that appears in the Alerts tab of the Adobe Experience Platform UI.
get_alert_subscription_for_asset_id_and_alert_type_not_found_error_message
object
The error response for a 404 status when requesting subscriber information for an asset ID and alert type.
2 properties
notification_channels
object
A boolean value to confirm the channel of alert notification subscribed to by the user.
2 properties
AlertType
string
This property determines the state of query execution that triggers a user to receive an alert. The alert type is one of three values (start, success, failure).
alerts_to_which_user_subscribed_response
object
Information about a particular alert.
4 properties
next
object
Pre-constructed URI for the next page of results, if any exist.
1 property
NotFoundError
object
An HTTP status code that indicates the page, or resource you are looking for cannot be found.
alert_deleted_not_found_error_message
object
The error response for a 404 status to delete an alert.
2 properties
post_not_found_error_message
object
The error response for a 404 status for a request to create and subscribe to a new alert.
2 properties
get_alert_subscription_for_asset_id_error_message
object
The error response for a 404 status when requesting alert information for an asset ID.
2 properties
version
integer
The version of this resource.
AlertTypeSuccess
string
This property determines the state of query execution that triggers a user to receive an alert. The alert type is one of three values (start, success, failure).
prev
object
Pre-constructed URI for the previous page of results, if any exist.
1 property
get_alert_subscription_for_asset_id_and_alert_type_bad_request_error_message
object
The error response for a 400 status when requesting subscriber information for an asset ID and alert type.
2 properties
get_alerts_to_which_user_subscribed_bad_request_error_message
object
The error response for a 400 status for a request to return all the alerts a user is subscribed to.
2 properties
subscribers_for_alert_by_assetId_and_alertType
object
A list of alerts for an assetId and alertType.
1 property
PagingProperties
object
Contains properties to describe the order, size, total number of pages, and current page.
5 properties
alert_deleted_bad_request_error_message
object
The error response for a 400 status to delete an alert.
2 properties
alert_subscription_response_body
object
The response when subscribing emailIDs to an alert for an assetId and alertType.
5 properties
alert_patched_bad_request_error_message
object
The error response for a 400 status to patch an alert.
2 properties
emailIdForSubscribing
string
A list of Adobe registered emailIDs that want to subscribe to the alert for a given assetId and alertType.
subscribe_user_to_alert_body
object
The request payload used to subscribe emailIds to query or schedule IDs for a given alert type.
3 properties 3 required
Email_ID_inContextNotifications
array
A list of the email IDs subscribed to notifications within the Platform UI.
Subscriptions
alert_links
object
An object that contains information such as the URIs and methods for common alert subscriptions use cases.
5 properties
Status
string
This represents the status of the alert. It is one of four values (enabled, enabling, disabled, disabling).
SubscriptionsBasic
object
An object that contains two arrays of subscriber email IDs divided by their selected notification channel.
2 properties
Email_ID_emailNotifications
array
A list of the email IDs subscribed to notifications by email.
SubscriptionEmailIdsByChannel
object
An object that contains two arrays of subscriber email IDs divided by their selected notification channel.
2 properties
alert_patched
alerts_per_imsorg_and_sandbox
object
4 properties
alert_deleted
object
An alert has been deleted for the assetId and alertType provided in the URI.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adobe-suite-alert-subscriptions-api-openapi.yml Raw ↑

Other APIs Adobe Suite publishes across the network.

Adobe Sign API
Adobe Experience Manager API
Adobe Stock API
Adobe Premiere Pro API
Adobe After Effects API
Adobe Target API
Adobe Campaign API
Adobe User Management API
Adobe I/O Events API
Adobe MCP Servers
Adobe Suite Accelerated Queries API
Adobe Suite Access Control Policies API
Where this information came from

This is an independent, third-party profile of Adobe Suite Alert Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.