mergeAccounts — Merging an account or site into another account

The mergeAccounts method moves a single site or an entire account into a different account. It migrates all contact records, site records, present and historical subscription records, and, in the case of a complete account merge, all users as well. When entire accounts are merged, the child account is marked inactive.

Both the master account and child account or site must belong to the same partner that is specified in the request’s authentication element.

When a site or account is migrated, the historical scan and backup data isn’t transferred with the site. If you migrated a site to a different account and need to retrieve its scan or backup history, you can move it back to the origin (child) account. If you merged accounts, migrating a site back to the origin account isn’t possible because the origin account becomes inactive.
Moving PCI account subscriptions isn’t possible. This feature is currently under development, but at this time, merging an account with PCI into another account will result in the child account retaining control of the PCI subscription, and it won’t be marked inactive.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

  • SiteLockOnlineRequest

    • authentication: The partner’s username, password, and branding

      • username: The partner’s API username

      • password: The partner’s API password

      • partner: (Optional) The brand name to use in messaging

    • mergeAccounts: The method name

      • master_account: (Required) The ID of the master account where the child_account or child_site will be moved.

      • child_account: (Conditional) The ID of the child account that will be merged into the master_account. This element is mandatory unless the child_site is specified. The child account will be set to inactive.

      • child_site: (Conditional) The ID of the child site that will be merged into the master_account. This element is mandatory unless the child_account is specified.

Example request

  • Account merge

  • Site merge

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <mergeAccounts>
        <master_account>1123450</master_account>
        <child_account>1267559</child_account>
    </mergeAccounts>
</SiteLockOnlineRequest>
<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <mergeAccounts>
        <master_account>1123450</master_account>
        <child_site>1325001</child_site>
    </mergeAccounts>
</SiteLockOnlineRequest>

Response format

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • mergeAccounts: The method name

      • message: A message with details of the operation

      • status: The status of the merge operation. The possible values are ok and error.

      • error: An error message. This element is present when status is error.

        • code: [attribute] - The error code, as described in Error codes

Example response

  • Account merge

  • Site merge

<SiteLockOnlineResponse>
    <mergeAccounts>
        <message>Account 1267559 merged into master account 1123450 OK</message>
        <status>ok</status>
    </mergeAccounts>
</SiteLockOnlineResponse>
<SiteLockOnlineResponse>
    <mergeAccounts>
        <message>Site 1325001 merged into master account 1123450 OK</message>
        <status>ok</status>
    </mergeAccounts>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <mergeAccounts>
        <error code="-3">No child specified for merge</error>
    </mergeAccounts>
</SiteLockOnlineResponse>

Error codes

The following table contains error response codes for the mergeAccounts call.

Code Meaning Description

-1

Bad Accounts For Merge

At least one of the accounts specified either doesn’t exist, or doesn’t belong to the requesting partner.

-3

No child specified for merge

Please specify a child of some kind (account or site) for the merger to take place.

1

Bad Master Account

The master account couldn’t be found.

2

Bad Child Account

The child account couldn’t be found.

3

Internal Server Error

Please try the request again. If the error persists, please contact SiteLock support. When doing so, please have a copy of the request XML handy and refer to this specific error code.

4

Cannot merge account into self

The master and child accounts are the same.

6

Internal Server Error

Please try the request again. If the error persists, please contact SiteLock support. When doing so, please have a copy of the request XML handy and refer to this specific error code.

7

Bad Child Site

The child site couldn’t be found.

8

Cannot merge child site into account to which it already belongs

The child site is already a child of the given master account.