Edit

Share via

UpdateClientLinks Service Operation - Customer Management

  • Article

Updates the status of the specified client links.

Note

Only a user with Super Admin or Standard credentials can add, update, and search for client links to advertiser accounts. Only a user with Super Admin credentials can add, update, and search for client links to customers. For more information, see the User Roles technical guide.

If your user is within an agency, then the operation may be used to update the client link status of any account that you manage or have invited to manage.

If your user is within a client customer that has one or more accounts managed or invited to be managed by an agency, then you may only use this operation to update the status as LinkAccepted or LinkDeclined. A client may also accept or decline the link request via the Microsoft Advertising web application.

Tip

For more information about the client link lifecycle, see the Account Hierarchy technical guide. For more information about becoming an agency, see the Resources for agency partners. For more information from a client's perspective, see How to have an agency manage your Microsoft Advertising account.

Request Elements

The UpdateClientLinksRequest 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
ClientLinks The list of client links to update.

You should limit your request to 10 client links per call.		 ClientLink array

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 UpdateClientLinksResponse 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
OperationErrors A list of one or more reasons why the service operation failed, and no client links were added. OperationError array
PartialErrors An array of OperationError lists that contain details for any client links that were not successfully added.

Results are returned in the same order corresponding to the requested client links. The number of first dimension list elements is equal to the requested client links count. For successfully added client links, the OperationError element at the corresponding index is null.		 OperationError array

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">UpdateClientLinks</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <UpdateClientLinksRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <ClientLinks xmlns:e577="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e577:ClientLink>
          <e577:Type i:nil="false">ValueHere</e577:Type>
          <e577:ClientEntityId i:nil="false">ValueHere</e577:ClientEntityId>
          <e577:ClientEntityNumber i:nil="false">ValueHere</e577:ClientEntityNumber>
          <e577:ClientEntityName i:nil="false">ValueHere</e577:ClientEntityName>
          <e577:ManagingCustomerId i:nil="false">ValueHere</e577:ManagingCustomerId>
          <e577:ManagingCustomerNumber i:nil="false">ValueHere</e577:ManagingCustomerNumber>
          <e577:ManagingCustomerName i:nil="false">ValueHere</e577:ManagingCustomerName>
          <e577:Note i:nil="false">ValueHere</e577:Note>
          <e577:Name i:nil="false">ValueHere</e577:Name>
          <e577:InviterEmail i:nil="false">ValueHere</e577:InviterEmail>
          <e577:InviterName i:nil="false">ValueHere</e577:InviterName>
          <e577:InviterPhone i:nil="false">ValueHere</e577:InviterPhone>
          <e577:IsBillToClient i:nil="false">ValueHere</e577:IsBillToClient>
          <e577:StartDate i:nil="false">ValueHere</e577:StartDate>
          <e577:Status i:nil="false">ValueHere</e577:Status>
          <e577:SuppressNotification>ValueHere</e577:SuppressNotification>
          <e577:LastModifiedDateTime>ValueHere</e577:LastModifiedDateTime>
          <e577:LastModifiedByUserId>ValueHere</e577:LastModifiedByUserId>
          <e577:Timestamp i:nil="false">ValueHere</e577:Timestamp>
          <e577:ForwardCompatibilityMap xmlns:e578="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e578:KeyValuePairOfstringstring>
              <e578:key i:nil="false">ValueHere</e578:key>
              <e578:value i:nil="false">ValueHere</e578:value>
            </e578:KeyValuePairOfstringstring>
          </e577:ForwardCompatibilityMap>
          <e577:CustomerLinkPermission i:nil="false">ValueHere</e577:CustomerLinkPermission>
        </e577:ClientLink>
      </ClientLinks>
    </UpdateClientLinksRequest>
  </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>
    <UpdateClientLinksResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <OperationErrors xmlns:e579="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e579:OperationError>
          <e579:Code>ValueHere</e579:Code>
          <e579:Details d4p1:nil="false">ValueHere</e579:Details>
          <e579:Message d4p1:nil="false">ValueHere</e579:Message>
        </e579:OperationError>
      </OperationErrors>
      <PartialErrors xmlns:e580="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e580:ArrayOfOperationError>
          <e580:OperationError>
            <e580:Code>ValueHere</e580:Code>
            <e580:Details d4p1:nil="false">ValueHere</e580:Details>
            <e580:Message d4p1:nil="false">ValueHere</e580:Message>
          </e580:OperationError>
        </e580:ArrayOfOperationError>
      </PartialErrors>
    </UpdateClientLinksResponse>
  </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<UpdateClientLinksResponse> UpdateClientLinksAsync(
	IList<ClientLink> clientLinks)
{
	var request = new UpdateClientLinksRequest
	{
		ClientLinks = clientLinks
	};

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

static UpdateClientLinksResponse updateClientLinks(
	ArrayOfClientLink clientLinks) throws RemoteException, Exception
{
	UpdateClientLinksRequest request = new UpdateClientLinksRequest();

	request.setClientLinks(clientLinks);

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

static function UpdateClientLinks(
	$clientLinks)
{

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

	$request = new UpdateClientLinksRequest();

	$request->ClientLinks = $clientLinks;

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

response=customermanagement_service.UpdateClientLinks(
	ClientLinks=ClientLinks)

Requirements

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

Request Url

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/ClientLinks

Request Elements

The UpdateClientLinksRequest 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
ClientLinks The list of client links to update.

You should limit your request to 10 client links per call.		 ClientLink array

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

Element Description Data Type
OperationErrors A list of one or more reasons why the service operation failed, and no client links were added. OperationError array
PartialErrors An array of OperationError lists that contain details for any client links that were not successfully added.

Results are returned in the same order corresponding to the requested client links. The number of first dimension list elements is equal to the requested client links count. For successfully added client links, the OperationError element at the corresponding index is null.		 OperationError array

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.

{
  "ClientLinks": [
    {
      "ClientEntityId": "LongValueHere",
      "ClientEntityName": "ValueHere",
      "ClientEntityNumber": "ValueHere",
      "CustomerLinkPermission": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "InviterEmail": "ValueHere",
      "InviterName": "ValueHere",
      "InviterPhone": "ValueHere",
      "IsBillToClient": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedDateTime": "ValueHere",
      "ManagingCustomerId": "LongValueHere",
      "ManagingCustomerName": "ValueHere",
      "ManagingCustomerNumber": "ValueHere",
      "Name": "ValueHere",
      "Note": "ValueHere",
      "StartDate": "ValueHere",
      "Status": "ValueHere",
      "SuppressNotification": "ValueHere",
      "Timestamp": "ValueHere",
      "Type": "ValueHere"
    }
  ]
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "OperationErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "Message": "ValueHere"
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "Message": "ValueHere"
    }
  ]
}

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<UpdateClientLinksResponse> UpdateClientLinksAsync(
	IList<ClientLink> clientLinks)
{
	var request = new UpdateClientLinksRequest
	{
		ClientLinks = clientLinks
	};

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

static UpdateClientLinksResponse updateClientLinks(
	ArrayOfClientLink clientLinks) throws RemoteException, Exception
{
	UpdateClientLinksRequest request = new UpdateClientLinksRequest();

	request.setClientLinks(clientLinks);

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

static function UpdateClientLinks(
	$clientLinks)
{

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

	$request = new UpdateClientLinksRequest();

	$request->ClientLinks = $clientLinks;

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

response=customermanagement_service.UpdateClientLinks(
	ClientLinks=ClientLinks)