DeleteUser Service Operation - Customer Management

Article
03/20/2023

Deletes a user.

Note

Only a user with Super Admin credentials can delete users. For more information, see the User Roles technical guide.

Because the delete operation requires the time stamp of the most recent user write operation, you must first call the GetUser operation. The GetUser operation returns the user's data, which includes the time stamp. The delete call will fail if you use an old time stamp e.g., the user data is updated by your application or another application after you obtained the time stamp.

You cannot delete a user who is the primary user of any accounts. Before you can delete a primary user, set the PrimaryUserId element of each account to a different user.

Request Elements

The DeleteUserRequest 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
TimeStamp	The time-stamp value that the operation uses to reconcile the update. You must call GetUser to get the time-stamp value. The delete operation fails if the user object has a time-stamp value that differs from the one that you pass.	base64Binary
UserId	The identifier of the user to delete.	long

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 DeleteUserResponse 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">DeleteUser</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <DeleteUserRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserId>ValueHere</UserId>
      <TimeStamp i:nil="false">ValueHere</TimeStamp>
    </DeleteUserRequest>
  </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>
    <DeleteUserResponse 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<DeleteUserResponse> DeleteUserAsync(
	long userId,
	base64Binary timeStamp)
{
	var request = new DeleteUserRequest
	{
		UserId = userId,
		TimeStamp = timeStamp
	};

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

static DeleteUserResponse deleteUser(
	java.lang.Long userId,
	byte[] timeStamp) throws RemoteException, Exception
{
	DeleteUserRequest request = new DeleteUserRequest();

	request.setUserId(userId);
	request.setTimeStamp(timeStamp);

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

static function DeleteUser(
	$userId,
	$timeStamp)
{

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

	$request = new DeleteUserRequest();

	$request->UserId = $userId;
	$request->TimeStamp = $timeStamp;

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

response=customermanagement_service.DeleteUser(
	UserId=UserId,
	TimeStamp=TimeStamp)

Requirements

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

Share via