deleteAccount — Deleting accounts and sites

The deleteAccount method deletes an account or a site. The accountInformation and siteInformation elements can be used to delete either an account or a site (at least one must be present).

Account deletion isn’t idempotent. Each attempted account deletion will delete an account.

The API endpoint is:

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

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authenticaion: 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
- deleteAccount: The method name
  - accountInformation: (Optional) The account to be deleted
    
    id: The ID of the account to be deleted, as returned by the SiteLock API account creation request.
  - siteInformation: (Optional) The site to be deleted
    
    id: The ID of the site to be deleted, as returned by the SiteLock API account creation request.

Example request deleting an entire account

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <deleteAccount>
        <accountInformation>
            <id>0123456789</id>
        </accountInformation>
    </deleteAccount>
</SiteLockOnlineRequest>

Example request deleting a single site

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <deleteAccount>
        <siteInformation>
            <id>0123456789</id>
        </siteInformation>
    </deleteAccount>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- deleteAccount: The method name
  - result: In case of success response
  - error: In case of error response

Example success response

<SiteLockOnlineResponse>
    <deleteAccount>
        <result>Success</result>
    </deleteAccount>
</SiteLockOnlineResponse>

The API responds with a result of Success if the account or site has been successfully deleted.

Example error response

<SiteLockOnlineResponse>
    <deleteAccount>
        <error>Could not parse XML request</error>
    </deleteAccount>
</SiteLockOnlineResponse>

The 500 Error status returns an XML payload containing an error message. This error message helps indicate where the issue with the account deletion lies. The most common error is invalid XML, such as unescaped characters or elements that aren’t closed. Other errors would include the attempt to delete a previously deleted account or other account information issues.