DismissNotifications Service Operation - Customer Management

Article
03/27/2024

A service operation to dismiss notifications.

Request Elements

The DismissNotificationsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
NotificationTypePairs	The key and value of a notification entity.	KeyValueEntityOflongint array
UserId	The user's identification number.	int

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The DismissNotificationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

There are not any elements in the operation's response body.

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <Action mustUnderstand="1">DismissNotifications</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <DismissNotificationsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserId i:nil="false">ValueHere</UserId>
      <NotificationTypePairs xmlns:e225="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e225:KeyValueEntityOflongint>
          <e225:Key>ValueHere</e225:Key>
          <e225:Value>ValueHere</e225:Value>
        </e225:KeyValueEntityOflongint>
      </NotificationTypePairs>
    </DismissNotificationsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <DismissNotificationsResponse xmlns="https://bingads.microsoft.com/Customer/v13" />
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<DismissNotificationsResponse> DismissNotificationsAsync(
	int? userId,
	IList<KeyValueEntityOflongint> notificationTypePairs)
{
	var request = new DismissNotificationsRequest
	{
		UserId = userId,
		NotificationTypePairs = notificationTypePairs
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.DismissNotificationsAsync(r), request));
}

static DismissNotificationsResponse dismissNotifications(
	int userId,
	ArrayOfKeyValueEntityOflongint notificationTypePairs) throws RemoteException, Exception
{
	DismissNotificationsRequest request = new DismissNotificationsRequest();

	request.setUserId(userId);
	request.setNotificationTypePairs(notificationTypePairs);

	return CustomerManagementService.getService().dismissNotifications(request);
}

static function DismissNotifications(
	$userId,
	$notificationTypePairs)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new DismissNotificationsRequest();

	$request->UserId = $userId;
	$request->NotificationTypePairs = $notificationTypePairs;

	return $GLOBALS['CustomerManagementProxy']->GetService()->DismissNotifications($request);
}

response=customermanagement_service.DismissNotifications(
	UserId=UserId,
	NotificationTypePairs=NotificationTypePairs)

Requirements

Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

Share via