ClientLinkStatus Value Set

 

Defines the possible status values of a ClientLink.

For more information about the client link lifecycle, see Link to Client Accounts.

<xs:simpleType name="ClientLinkStatus">
      <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>

ValueDescriptionRead or Write Permissions
ActiveThe link is established and the managing customer can access the client account.

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

The previous status was UnlinkInProgress.
Read-only
LinkAcceptedThe invited client should use this value to accept the link invitation.

The previous status was LinkPending.
Read and write are both supported.

Only the invited client may set this status, and then on the client link start date the service sets the effective status to LinkInProgress.
LinkCanceledThe link request has been canceled by the agency.

The previous status was LinkPending.
Read and write are both supported.

Only the agency may set this status.
LinkDeclinedThe link request has been declined by the invited client.

The previous status was LinkPending.
Read and write are both supported.

Only the invited client may set this status.
LinkExpiredThe link is inactive due to expiry. The client did not accept or decline the request within 30 days.

The previous status was LinkPending.
Read-only
LinkFailedThe link process failed to complete successfully.

The previous status was LinkInProgress.
Read-only
LinkInProgressThe 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.
Read-only
LinkPendingThe ClientLink has been added via the AddClientLinks operation. The link request has been sent and is pending approval from the client.Read-only
UnlinkCanceledReserved for future use.Not applicable.
UnlinkFailedThe unlink process failed to complete successfully, for example because the billing transition could not be completed.

The previous status was UnlinkInProgress.
Write-only

Only the system can set this status value if the unlink process fails, which resumes the Active status.
UnlinkInProgressThe unlink process is in progress and waiting for the billing transition to complete.

The previous status was UnlinkPending.
Read-only
UnlinkPendingA 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.
Read-only
UnlinkRequestedThe agency should use this value to request an unlink.

The previous status was Active.
Write-only

Only an agency can set this status, and then the service sets the effective status to UnlinkPending.

CustomerManagementService.svc v11

Namespace: https://bingads.microsoft.com/Customer/v11

ClientLink
SearchClientLinks
UpdateClientLinks

Show: