SignupCustomer Service Operation - Customer Management

4/9/2018
4 minutes to read
Contributors

Creates a new customer and account that rolls up to your reseller payment method.

Note

You must be a reseller with aggregator user permissions to call this operation. For more details see Management Model for Resellers.

Pass both Customer and AdvertiserAccount objects in the request. The customer object includes the customer's name, the address where the customer is located, the market in which the customer operates, and the industry in which the customer participates. Although it is possible to add multiple customers with the same details, you should use unique customer names so that users can easily distinguish between customers in a user interface.

The account object must specify the name of the account; the type of currency to use to settle the account; and the payment method identifier, which must be set to null. The operation generates an invoice account and sets the payment method identifier to the identifier associated with the reseller's invoice. You are invoiced for all charges incurred by the customers that you manage.

If the operation succeeds, a new managed customer is created outside of the reseller customer and an account is created within the managed customer.

Request Elements

The SignupCustomerRequest 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
Account	An AdvertiserAccount that specifies the details of the customer's primary account. Do not instantiate the Account data object. Instead, instantiate the AdvertiserAccount that derives from the Account data object.	AdvertiserAccount
Customer	A Customer that specifies the details of the customer that you are adding.	Customer
ParentCustomerId	The customer identifier of the reseller that will manage this customer.	long

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 SignupCustomerResponse 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

Element	Description	Data Type
AccountId	A 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
AccountNumber	A 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
CreateTime	The 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
CustomerId	A 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
CustomerNumber	A 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 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/v12">
    <Action mustUnderstand="1">SignupCustomer</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>
    <SignupCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v12">
      <Customer xmlns:e900="https://bingads.microsoft.com/Customer/v12/Entities" i:nil="false">
        <e900:CustomerFinancialStatus i:nil="false">ValueHere</e900:CustomerFinancialStatus>
        <e900:Id i:nil="false">ValueHere</e900:Id>
        <e900:Industry i:nil="false">ValueHere</e900:Industry>
        <e900:LastModifiedByUserId i:nil="false">ValueHere</e900:LastModifiedByUserId>
        <e900:LastModifiedTime i:nil="false">ValueHere</e900:LastModifiedTime>
        <e900:MarketCountry i:nil="false">ValueHere</e900:MarketCountry>
        <ForwardCompatibilityMap xmlns:e901="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e901:KeyValuePairOfstringstring>
            <e901:key i:nil="false">ValueHere</e901:key>
            <e901:value i:nil="false">ValueHere</e901:value>
          </e901:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <e900:MarketLanguage i:nil="false">ValueHere</e900:MarketLanguage>
        <e900:Name i:nil="false">ValueHere</e900:Name>
        <e900:ServiceLevel i:nil="false">ValueHere</e900:ServiceLevel>
        <e900:CustomerLifeCycleStatus i:nil="false">ValueHere</e900:CustomerLifeCycleStatus>
        <e900:TimeStamp i:nil="false">ValueHere</e900:TimeStamp>
        <e900:Number i:nil="false">ValueHere</e900:Number>
      </Customer>
      <Account xmlns:e902="https://bingads.microsoft.com/Customer/v12/Entities" i:nil="false">
        <e902:BillToCustomerId i:nil="false">ValueHere</e902:BillToCustomerId>
        <e902:CurrencyCode i:nil="false">ValueHere</e902:CurrencyCode>
        <e902:AccountFinancialStatus i:nil="false">ValueHere</e902:AccountFinancialStatus>
        <e902:Id i:nil="false">ValueHere</e902:Id>
        <e902:Language i:nil="false">ValueHere</e902:Language>
        <e902:LastModifiedByUserId i:nil="false">ValueHere</e902:LastModifiedByUserId>
        <e902:LastModifiedTime i:nil="false">ValueHere</e902:LastModifiedTime>
        <e902:Name i:nil="false">ValueHere</e902:Name>
        <e902:Number i:nil="false">ValueHere</e902:Number>
        <e902:ParentCustomerId>ValueHere</e902:ParentCustomerId>
        <e902:PaymentMethodId i:nil="false">ValueHere</e902:PaymentMethodId>
        <e902:PaymentMethodType i:nil="false">ValueHere</e902:PaymentMethodType>
        <e902:PrimaryUserId i:nil="false">ValueHere</e902:PrimaryUserId>
        <e902:AccountLifeCycleStatus i:nil="false">ValueHere</e902:AccountLifeCycleStatus>
        <e902:TimeStamp i:nil="false">ValueHere</e902:TimeStamp>
        <e902:TimeZone i:nil="false">ValueHere</e902:TimeZone>
        <e902:PauseReason i:nil="false">ValueHere</e902:PauseReason>
        <ForwardCompatibilityMap xmlns:e903="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e903:KeyValuePairOfstringstring>
            <e903:key i:nil="false">ValueHere</e903:key>
            <e903:value i:nil="false">ValueHere</e903:value>
          </e903:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <e902:LinkedAgencies i:nil="false">
          <e902:CustomerInfo>
            <e902:Id i:nil="false">ValueHere</e902:Id>
            <e902:Name i:nil="false">ValueHere</e902:Name>
          </e902:CustomerInfo>
        </e902:LinkedAgencies>
        <e902:SalesHouseCustomerId i:nil="false">ValueHere</e902:SalesHouseCustomerId>
        <TaxInformation xmlns:e904="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e904:KeyValuePairOfstringstring>
            <e904:key i:nil="false">ValueHere</e904:key>
            <e904:value i:nil="false">ValueHere</e904:value>
          </e904:KeyValuePairOfstringstring>
        </TaxInformation>
        <e902:BackUpPaymentInstrumentId i:nil="false">ValueHere</e902:BackUpPaymentInstrumentId>
        <e902:BillingThresholdAmount i:nil="false">ValueHere</e902:BillingThresholdAmount>
        <e902:BusinessAddress i:nil="false">
          <e902:City i:nil="false">ValueHere</e902:City>
          <e902:CountryCode i:nil="false">ValueHere</e902:CountryCode>
          <e902:Id i:nil="false">ValueHere</e902:Id>
          <e902:Line1 i:nil="false">ValueHere</e902:Line1>
          <e902:Line2 i:nil="false">ValueHere</e902:Line2>
          <e902:Line3 i:nil="false">ValueHere</e902:Line3>
          <e902:Line4 i:nil="false">ValueHere</e902:Line4>
          <e902:PostalCode i:nil="false">ValueHere</e902:PostalCode>
          <e902:StateOrProvince i:nil="false">ValueHere</e902:StateOrProvince>
          <e902:TimeStamp i:nil="false">ValueHere</e902:TimeStamp>
          <e902:BusinessName i:nil="false">ValueHere</e902:BusinessName>
        </e902:BusinessAddress>
        <e902:AutoTagType i:nil="false">ValueHere</e902:AutoTagType>
        <e902:SoldToPaymentInstrumentId i:nil="false">ValueHere</e902:SoldToPaymentInstrumentId>
      </Account>
      <ParentCustomerId i:nil="false">ValueHere</ParentCustomerId>
    </SignupCustomerRequest>
  </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/v12">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SignupCustomerResponse xmlns="https://bingads.microsoft.com/Customer/v12">
      <CustomerId>ValueHere</CustomerId>
      <CustomerNumber d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</CustomerNumber>
      <AccountId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</AccountId>
      <AccountNumber d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</AccountNumber>
      <CreateTime>ValueHere</CreateTime>
    </SignupCustomerResponse>
  </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<SignupCustomerResponse> SignupCustomerAsync(
    Customer customer,
    AdvertiserAccount account,
    long? parentCustomerId)
{
    var request = new SignupCustomerRequest
    {
        Customer = customer,
        Account = account,
        ParentCustomerId = parentCustomerId
    };

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

static SignupCustomerResponse signupCustomer(
    Customer customer,
    AdvertiserAccount account,
    java.lang.Long parentCustomerId) throws RemoteException, Exception
{
    SignupCustomerRequest request = new SignupCustomerRequest();

    request.setCustomer(customer);
    request.setAccount(account);
    request.setParentCustomerId(parentCustomerId);

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

static function SignupCustomer(
    $customer,
    $account,
    $parentCustomerId)
{

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

    $request = new SignupCustomerRequest();

    $request->Customer = $customer;
    $request->Account = $account;
    $request->ParentCustomerId = $parentCustomerId;

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

response=customermanagement_service.SignupCustomer(
    Customer=Customer,
    Account=Account,
    ParentCustomerId=ParentCustomerId)

Requirements

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