DeleteCustomer Service Operation - Customer Management

Deletes a customer.

Request Elements

The DeleteCustomerRequest 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.

Request Body Elements

Element Description Data Type
CustomerId The identifier of the customer to delete. long
TimeStamp The time-stamp value that the operation uses to reconcile the update. You must call GetCustomer to get the time-stamp value. The delete operation fails if the customer 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 a Microsoft Account user who has permissions to Bing Ads accounts. string
DeveloperToken The developer token used to access the Bing Ads API. string
Password The Bing Ads managed user's sign-in password. string
UserName The Bing Ads managed user's sign-in name. You must not set this element to a Microsoft account or email address. string

Important

The UserName and Password header elements are deprecated. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account (email address) authentication. For more information, see Authentication with OAuth. UserName and Password are still required for Bing Ads managed credentials, but they are not applicable for Microsoft account authentication. To authenticate a Microsoft account, use the AuthenticationToken] header instead of UserName and Password.

Response Elements

The DeleteCustomerResponse 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

The following template shows the order of the body and header elements for the SOAP request.

<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/v11">
    <Action mustUnderstand="1">DeleteCustomer</Action>
    <ApplicationToken i:nil="false">ValueHere</ApplicationToken>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
    <Password i:nil="false">ValueHere</Password>
    <UserName i:nil="false">ValueHere</UserName>
  </s:Header>
  <s:Body>
    <DeleteCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v11">
      <CustomerId>ValueHere</CustomerId>
      <TimeStamp i:nil="false">ValueHere</TimeStamp>
    </DeleteCustomerRequest>
  </s:Body>
</s:Envelope>

Response SOAP

The following template shows 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/v11">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <DeleteCustomerResponse xmlns="https://bingads.microsoft.com/Customer/v11" />
  </s:Body>
</s:Envelope>

Code Syntax

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

public async Task<DeleteCustomerResponse> DeleteCustomerAsync(
    long customerId,
    base64Binary timeStamp)
{
    var request = new DeleteCustomerRequest
    {
        CustomerId = customerId,
        TimeStamp = timeStamp
    };

    return (await CustomerManagementService.CallAsync((s, r) => s.DeleteCustomerAsync(r), request));
}
static DeleteCustomerResponse deleteCustomer(
    java.lang.Long customerId,
    byte[] timeStamp) throws RemoteException, Exception
{
    DeleteCustomerRequest request = new DeleteCustomerRequest();

    request.setCustomerId(customerId);
    request.setTimeStamp(timeStamp);

    return CustomerManagementService.getService().deleteCustomer(request);
}
static function DeleteCustomer(
    $customerId,
    $timeStamp)
{

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

    $request = new DeleteCustomerRequest();

    $request->CustomerId = $customerId;
    $request->TimeStamp = $timeStamp;

    return $GLOBALS['CustomerManagementProxy']->GetService()->DeleteCustomer($request);
}
response=customermanagement_service.DeleteCustomer(
    CustomerId=CustomerId,
    TimeStamp=TimeStamp)

Requirements

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