DeleteAccount Service Operation - Customer Management
Deletes an account.
Note
Only a user with Super Admin credentials can delete accounts. For more information, see the User Roles technical guide.
Because the delete operation requires the time stamp of the most recent account write operation, you must first call the GetAccount operation. The GetAccount operation returns the account's data, which includes the time stamp. The delete call will fail if you use an old time stamp e.g., the account data is updated by your application or another application after you obtained the time stamp.
After deleting the account it will be searchable and show as inactive in the Microsoft Advertising web application. You may or may not choose to surface inactive accounts in your application.
Request Elements
The DeleteAccountRequest 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 |
|---|---|---|
| AccountId | The identifier of the account to delete. | long |
| TimeStamp | The time-stamp value that the operation uses to reconcile the update. You must call GetAccount to get the time-stamp value. The delete operation fails if the account object has a time-stamp value that differs from the one that you pass. | base64Binary |
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 DeleteAccountResponse 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">DeleteAccount</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<DeleteAccountRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<AccountId>ValueHere</AccountId>
<TimeStamp i:nil="false">ValueHere</TimeStamp>
</DeleteAccountRequest>
</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>
<DeleteAccountResponse 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<DeleteAccountResponse> DeleteAccountAsync(
long accountId,
base64Binary timeStamp)
{
var request = new DeleteAccountRequest
{
AccountId = accountId,
TimeStamp = timeStamp
};
return (await CustomerManagementService.CallAsync((s, r) => s.DeleteAccountAsync(r), request));
}
static DeleteAccountResponse deleteAccount(
java.lang.Long accountId,
byte[] timeStamp) throws RemoteException, Exception
{
DeleteAccountRequest request = new DeleteAccountRequest();
request.setAccountId(accountId);
request.setTimeStamp(timeStamp);
return CustomerManagementService.getService().deleteAccount(request);
}
static function DeleteAccount(
$accountId,
$timeStamp)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new DeleteAccountRequest();
$request->AccountId = $accountId;
$request->TimeStamp = $timeStamp;
return $GLOBALS['CustomerManagementProxy']->GetService()->DeleteAccount($request);
}
response=customermanagement_service.DeleteAccount(
AccountId=AccountId,
TimeStamp=TimeStamp)
Requirements
Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
Request Url
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Account
Request Elements
The DeleteAccountRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AccountId | The identifier of the account to delete. | long |
| TimeStamp | The time-stamp value that the operation uses to reconcile the update. You must call GetAccount to get the time-stamp value. The delete operation fails if the account object has a time-stamp value that differs from the one that you pass. | base64Binary |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. 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 DeleteAccountResponse 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 JSON.
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 JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"AccountId": "LongValueHere",
"TimeStamp": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
{}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<DeleteAccountResponse> DeleteAccountAsync(
long accountId,
base64Binary timeStamp)
{
var request = new DeleteAccountRequest
{
AccountId = accountId,
TimeStamp = timeStamp
};
return (await CustomerManagementService.CallAsync((s, r) => s.DeleteAccountAsync(r), request));
}
static DeleteAccountResponse deleteAccount(
java.lang.Long accountId,
byte[] timeStamp) throws RemoteException, Exception
{
DeleteAccountRequest request = new DeleteAccountRequest();
request.setAccountId(accountId);
request.setTimeStamp(timeStamp);
return CustomerManagementService.getService().deleteAccount(request);
}
static function DeleteAccount(
$accountId,
$timeStamp)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new DeleteAccountRequest();
$request->AccountId = $accountId;
$request->TimeStamp = $timeStamp;
return $GLOBALS['CustomerManagementProxy']->GetService()->DeleteAccount($request);
}
response=customermanagement_service.DeleteAccount(
AccountId=AccountId,
TimeStamp=TimeStamp)