UpdateCustomer Service Operation

 

Updates the details of the specified customer.

Request | Response

Error Codes

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

Request Body

The UpdateCustomerRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP Request SOAP.

ElementDescriptionData Type
CustomerA customer object that contains the updated customer information.

This operation overwrites the existing customer data with the contents of the customer object that you pass. This operation performs a full update, and not a partial update. The Customer object must contain the time stamp value from the last time that the Customer object was written to. To ensure that the time stamp contains the correct value, call the GetCustomer operation. You can then update the customer data as appropriate, and call UpdateCustomer.
Customer

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Managing User Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts.string
DeveloperTokenThe developer token used to access the Bing Ads API.string

Password Authentication

These request headers are required for legacy username and password authentication.

ElementDescriptionData Type
DeveloperTokenThe developer token used to access the Bing Ads API.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You must not set this element to a Microsoft account or email address. To authenticate a Microsoft account, use the AuthenticationToken header instead of UserName and Password.string

Request SOAP

The following example shows the complete request envelope.

<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/v9">
    <Action mustUnderstand="1">UpdateCustomer</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <UpdateCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v9">
      <Customer xmlns:e31="https://bingads.microsoft.com/Customer/v9/Entities" i:nil="false">
        <e31:CustomerAddress i:nil="false">
          <e31:City i:nil="false"></e31:City>
          <e31:CountryCode i:nil="false"></e31:CountryCode>
          <e31:Id i:nil="false"></e31:Id>
          <e31:Line1 i:nil="false"></e31:Line1>
          <e31:Line2 i:nil="false"></e31:Line2>
          <e31:Line3 i:nil="false"></e31:Line3>
          <e31:Line4 i:nil="false"></e31:Line4>
          <e31:PostalCode i:nil="false"></e31:PostalCode>
          <e31:StateOrProvince i:nil="false"></e31:StateOrProvince>
          <e31:TimeStamp i:nil="false"></e31:TimeStamp>
        </e31:CustomerAddress>
        <e31:CustomerFinancialStatus i:nil="false"></e31:CustomerFinancialStatus>
        <e31:Id i:nil="false"></e31:Id>
        <e31:Industry i:nil="false"></e31:Industry>
        <e31:LastModifiedByUserId i:nil="false"></e31:LastModifiedByUserId>
        <e31:LastModifiedTime i:nil="false"></e31:LastModifiedTime>
        <e31:MarketCountry i:nil="false"></e31:MarketCountry>
        <ForwardCompatibilityMap xmlns:e32="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e32:KeyValuePairOfstringstring>
            <e32:key i:nil="false"></e32:key>
            <e32:value i:nil="false"></e32:value>
          </e32:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <e31:MarketLanguage i:nil="false"></e31:MarketLanguage>
        <e31:Name i:nil="false"></e31:Name>
        <e31:ServiceLevel i:nil="false"></e31:ServiceLevel>
        <e31:CustomerLifeCycleStatus i:nil="false"></e31:CustomerLifeCycleStatus>
        <e31:TimeStamp i:nil="false"></e31:TimeStamp>
        <e31:Number i:nil="false"></e31:Number>
      </Customer>
    </UpdateCustomerRequest>
  </s:Body>
</s:Envelope>

Response Body

The response does not contain additional body elements.

Response Header

ElementDescriptionData Type
TrackingIdThe identifier of the log entry that contains the details of the API call.string

Response SOAP

The following example shows the complete response envelope.

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

If the service operation fails, it throws a FaultException, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Customer Management Error Data Objects and Handling Service Errors and Exceptions.The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code
InvalidCredentials
Show: