Notification Recipient Email - Create Or Update

Adds the Email address to the list of Recipients for the Notification.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}?api-version=2019-01-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

notificationName
path True

Notification Name Identifier.

email
path True
  • string

Email identifier.

api-version
query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

Recipient Email is already part of the notification list.

201 Created

Recipient Email was successfully added to the notification list.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementCreateNotificationRecipientEmail

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com?api-version=2019-01-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

NotificationName

Notification Name Identifier.

RecipientEmailContract

Recipient Email details.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

NotificationName

Notification Name Identifier.

Name Type Description
AccountClosedPublisher
  • string

The following email recipients and users will receive email notifications when developer closes his account.

BCC
  • string

The following recipients will receive blind carbon copies of all emails sent to developers.

NewApplicationNotificationMessage
  • string

The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.

NewIssuePublisherNotificationMessage
  • string

The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.

PurchasePublisherNotificationMessage
  • string

The following email recipients and users will receive email notifications about new API product subscriptions.

QuotaLimitApproachingPublisherNotificationMessage
  • string

The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.

RequestPublisherNotificationMessage
  • string

The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.

RecipientEmailContract

Recipient Email details.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.email
  • string

User Email subscribed to notification.

type
  • string

Resource type for API Management resource.