SignupCustomer Service Operation

 

Signs up a customer with Bing Ads.

Request | Response

Error Codes

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

Request Body

The SignupCustomerRequest 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 TypeRequired
AccountAn Account that specifies the details of the customer’s primary account.

Note: Do not instantiate the Account data object. Instead, instantiate the AdvertiserAccount that derives from the Account data object.
AccountYes
ApplicationScopeDetermines the type of customer application. The default is Advertiser.

The scope of this customer and the scope of the parent customer must be the same; for example, they must both be set to Advertiser.
ApplicationTypeNo
CustomerA Customer that specifies the details of the customer that you are adding.CustomerYes
ParentCustomerIdThe customer identifier of the reseller that will manage this customer.longYes

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 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/v11">
    <Action mustUnderstand="1">SignupCustomer</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>
    <SignupCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v11">
      <Customer xmlns:e46="https://bingads.microsoft.com/Customer/v11/Entities" i:nil="false">
        <e46:CustomerAddress i:nil="false">
          <e46:City i:nil="false"></e46:City>
          <e46:CountryCode i:nil="false"></e46:CountryCode>
          <e46:Id i:nil="false"></e46:Id>
          <e46:Line1 i:nil="false"></e46:Line1>
          <e46:Line2 i:nil="false"></e46:Line2>
          <e46:Line3 i:nil="false"></e46:Line3>
          <e46:Line4 i:nil="false"></e46:Line4>
          <e46:PostalCode i:nil="false"></e46:PostalCode>
          <e46:StateOrProvince i:nil="false"></e46:StateOrProvince>
          <e46:TimeStamp i:nil="false"></e46:TimeStamp>
        </e46:CustomerAddress>
        <e46:CustomerFinancialStatus i:nil="false"></e46:CustomerFinancialStatus>
        <e46:Id i:nil="false"></e46:Id>
        <e46:Industry i:nil="false"></e46:Industry>
        <e46:LastModifiedByUserId i:nil="false"></e46:LastModifiedByUserId>
        <e46:LastModifiedTime i:nil="false"></e46:LastModifiedTime>
        <e46:MarketCountry i:nil="false"></e46:MarketCountry>
        <ForwardCompatibilityMap xmlns:e47="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e47:KeyValuePairOfstringstring>
            <e47:key i:nil="false"></e47:key>
            <e47:value i:nil="false"></e47:value>
          </e47:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <e46:MarketLanguage i:nil="false"></e46:MarketLanguage>
        <e46:Name i:nil="false"></e46:Name>
        <e46:ServiceLevel i:nil="false"></e46:ServiceLevel>
        <e46:CustomerLifeCycleStatus i:nil="false"></e46:CustomerLifeCycleStatus>
        <e46:TimeStamp i:nil="false"></e46:TimeStamp>
        <e46:Number i:nil="false"></e46:Number>
      </Customer>
      <Account xmlns:e48="https://bingads.microsoft.com/Customer/v11/Entities" i:nil="false" i:type="-- specify derived type here with the appropriate prefix --">
        <e48:AccountType></e48:AccountType>
        <e48:BillToCustomerId i:nil="false"></e48:BillToCustomerId>
        <e48:CountryCode i:nil="false"></e48:CountryCode>
        <e48:CurrencyType i:nil="false"></e48:CurrencyType>
        <e48:AccountFinancialStatus i:nil="false"></e48:AccountFinancialStatus>
        <e48:Id i:nil="false"></e48:Id>
        <e48:Language i:nil="false"></e48:Language>
        <ForwardCompatibilityMap xmlns:e49="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e49:KeyValuePairOfstringstring>
            <e49:key i:nil="false"></e49:key>
            <e49:value i:nil="false"></e49:value>
          </e49:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <e48:LastModifiedByUserId i:nil="false"></e48:LastModifiedByUserId>
        <e48:LastModifiedTime i:nil="false"></e48:LastModifiedTime>
        <e48:Name i:nil="false"></e48:Name>
        <e48:Number i:nil="false"></e48:Number>
        <e48:ParentCustomerId></e48:ParentCustomerId>
        <e48:PaymentMethodId i:nil="false"></e48:PaymentMethodId>
        <e48:PaymentMethodType i:nil="false"></e48:PaymentMethodType>
        <e48:PrimaryUserId i:nil="false"></e48:PrimaryUserId>
        <e48:AccountLifeCycleStatus i:nil="false"></e48:AccountLifeCycleStatus>
        <e48:TimeStamp i:nil="false"></e48:TimeStamp>
        <e48:TimeZone i:nil="false"></e48:TimeZone>
        <e48:PauseReason i:nil="false"></e48:PauseReason>
        <!--Keep these fields if you set the i:type attribute to AdvertiserAccount-->
        <e48:LinkedAgencies i:nil="false">
          <e48:CustomerInfo>
            <e48:Id i:nil="false"></e48:Id>
            <e48:Name i:nil="false"></e48:Name>
          </e48:CustomerInfo>
        </e48:LinkedAgencies>
        <e48:SalesHouseCustomerId i:nil="false"></e48:SalesHouseCustomerId>
        <TaxInformation xmlns:e50="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e50:KeyValuePairOfstringstring>
            <e50:key i:nil="false"></e50:key>
            <e50:value i:nil="false"></e50:value>
          </e50:KeyValuePairOfstringstring>
        </TaxInformation>
        <e48:BackUpPaymentInstrumentId i:nil="false"></e48:BackUpPaymentInstrumentId>
        <e48:BillingThresholdAmount i:nil="false"></e48:BillingThresholdAmount>
        <e48:BusinessAddress i:nil="false">
          <e48:City i:nil="false"></e48:City>
          <e48:CountryCode i:nil="false"></e48:CountryCode>
          <e48:Id i:nil="false"></e48:Id>
          <e48:Line1 i:nil="false"></e48:Line1>
          <e48:Line2 i:nil="false"></e48:Line2>
          <e48:Line3 i:nil="false"></e48:Line3>
          <e48:Line4 i:nil="false"></e48:Line4>
          <e48:PostalCode i:nil="false"></e48:PostalCode>
          <e48:StateOrProvince i:nil="false"></e48:StateOrProvince>
          <e48:TimeStamp i:nil="false"></e48:TimeStamp>
        </e48:BusinessAddress>
      </Account>
      <ParentCustomerId i:nil="false"></ParentCustomerId>
      <ApplicationScope></ApplicationScope>
    </SignupCustomerRequest>
  </s:Body>
</s:Envelope>

Response Body

System_CAPS_ICON_note.jpg Note

Identifiers returned in the response may not be immediately available . As a best practice, you should not use customer and account identifiers in subsequent service calls until 10-30 seconds after receiving the response from SignupCustomer.

ElementDescriptionData Type
AccountIdA system-generated account identifier corresponding to the new account specified in the request.

Use this identifier with operation requests that require an AccountId element and a CustomerAccountId SOAP header element.
long
AccountNumberA system-generated account number that is used to identify the account in the Bing Ads web application. The account number has the form, Xnnnnnnn, where nnnnnnn is a series of digits.string
CreateTimeThe date and time that the account was added. The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.dateTime
CustomerIdA system-generated customer identifier corresponding to the new customer specified in the request.

Use this identifier with operation requests that require a CustomerId SOAP header element.
long
CustomerNumberA system-generated customer number that is used in the Bing Ads web application. The customer number is of the form, Cnnnnnnn, where nnnnnnn is a series of digits.string

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/v11">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <SignupCustomerResponse xmlns="https://bingads.microsoft.com/Customer/v11">
      <CustomerId></CustomerId>
      <CustomerNumber p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></CustomerNumber>
      <AccountId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></AccountId>
      <AccountNumber p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></AccountNumber>
      <CreateTime></CreateTime>
    </SignupCustomerResponse>
  </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.

Code
105
310
Show: