Edit

ClientLinkStatus Value Set - Customer Management

  • Article

Defines the possible status values of a ClientLink.

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.

Syntax

<xs:simpleType name="ClientLinkStatus" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo>
      <ActualType Name="unsignedByte" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
    </xs:appinfo>
  </xs:annotation>
  <xs:restriction base="xs:string">
    <xs:enumeration value="LinkPending" />
    <xs:enumeration value="LinkCanceled" />
    <xs:enumeration value="LinkExpired" />
    <xs:enumeration value="LinkAccepted" />
    <xs:enumeration value="LinkDeclined" />
    <xs:enumeration value="LinkInProgress" />
    <xs:enumeration value="Active" />
    <xs:enumeration value="LinkFailed" />
    <xs:enumeration value="UnlinkRequested" />
    <xs:enumeration value="UnlinkPending" />
    <xs:enumeration value="UnlinkCanceled" />
    <xs:enumeration value="UnlinkInProgress" />
    <xs:enumeration value="Inactive" />
    <xs:enumeration value="UnlinkFailed" />
  </xs:restriction>
</xs:simpleType>

Values

The ClientLinkStatus value set has the following values: Active, Inactive, LinkAccepted, LinkCanceled, LinkDeclined, LinkExpired, LinkFailed, LinkInProgress, LinkPending, UnlinkCanceled, UnlinkFailed, UnlinkInProgress, UnlinkPending, UnlinkRequested.

Value Description
Active The link is established and the managing customer can access the client account.

The previous status was LinkInProgress.
Inactive The unlink process has completed and the managing customer can no longer access the client account.

The previous status was UnlinkInProgress.
LinkAccepted The invited client should use this value to accept the link invitation.

The previous status was LinkPending.
LinkCanceled The link request has been canceled by the agency.

The previous status was LinkPending.
LinkDeclined The link request has been declined by the invited client.

The previous status was LinkPending.
LinkExpired The link is inactive due to expiry. The client did not accept or decline the request within 30 days.

The previous status was LinkPending.
LinkFailed The link process failed to complete successfully.

The previous status was LinkInProgress.
LinkInProgress The link process is in progress and either waiting for the billing transition to complete or the specified client link start date has not yet arrived.

The previous readable status was LinkPending, and the previous write-only status set by the client was LinkAccepted.
LinkPending The ClientLink has been added via the AddClientLinks operation. The link request has been sent and is pending approval from the client.
UnlinkCanceled Reserved for future use.
UnlinkFailed The unlink process failed to complete successfully, for example because the billing transition could not be completed.

The previous status was UnlinkInProgress.
UnlinkInProgress The unlink process is in progress and waiting for the billing transition to complete.

The previous status was UnlinkPending.
UnlinkPending A request to terminate the link has been sent. The request is waiting for the system to begin the unlink progress.

The previous status was Active, and the next status will be UnlinkInProgress.
UnlinkRequested The agency should use this value to request an unlink.

The previous status was Active.

Requirements

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

Used By

ClientLink