modifyAccount — Modifying existing accounts

The modifyAccount method modifies an existing account.

The API endpoint is:

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

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- 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
- modifyAccount: The method name
  - siteInformation: The new user’s domain information
    
    id: The ID of the site to update
    
    subscription: The ID of the subscription to apply to the account
    
    bundle: The ID of the bundle to apply to the account. It cannot be used in conjunction with subscription. This element must be specified if the user is being upgraded into a SiteLock bundle.
    
    amount: The decimal amount the user was billed for this site. This field applies to items added with the subscription and bundle elements.
    
    This element isn’t optional when partner invoicing is based on revenue sharing.
    
    renewal_date: (Optional) The desired renewal date for the subscription. Instead of specifying a date, one may also specify the keyword preserve to keep the existing renewal date associated with the subscription being updated.
  - accountInformation: The user’s account information
    
    id: The ID of the account to update
    
    email: The new email for this account

A single request cannot be used for updating both site and account email information. Either siteInformation or accountInformation may be present in a single call.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <modifyAccount>
        <siteInformation>
            <id>1077</id>
            <subscription>8</subscription>
            <amount>5.00</amount>
            <renewal_date>2015-01-01</renewal_date>
        </siteInformation>
    </modifyAccount>
</SiteLockOnlineRequest>

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <modifyAccount>
        <accountInformation>
            <id>569457</id>
            <email>[email protected]</email>
        </accountInformation>
    </modifyAccount>
</SiteLockOnlineRequest>

Response format

Example success response

When the request pertains to updating site information, a success response returns sites updated.

<SiteLockOnlineResponse>
    <modifyAccount>
        <siteInformation>
            <id>12345</id>
        </siteInformation>
    </modifyAccount>
</SiteLockOnlineResponse>

When the request pertains to updating account email information, a success response returns the following.

<SiteLockOnlineResponse>
    <result>Account updated</result>
</SiteLockOnlineResponse>

Example error response

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

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

When the request pertains to updating site information, the error response is the following.

<SiteLockOnlineResponse>
    <error>site_id 1077 not found</error>
</SiteLockOnlineResponse>

This error indicates that site ID 1077 wasn’t found. No information changed for site ID 1077.

When the request pertains to updating account information, the error response is the following.

<SiteLockOnlineResponse>
    <error>account_id 569457 not found</error>
</SiteLockOnlineResponse>

This error indicates that account ID 569457 wasn’t found. No information changed for account ID 569457.

Using modifyAccount with a parked site

See also: Provisioning parked sites

When a partner has provisioned a site without specifying the domain name, this site is considered a parked site. A partner can subsequently call modifyAccount specifying just the site id, along with the three domain related elements, to convert a parked site to a regular site with services.

As a result of this call:

SiteLock will apply the earlier provisioned credits to the site, all checks that are conducted at provisioning time are repeated (for example, whether the domain name is valid, when the WAF is being provisioned, whether a BASIC WAF being provisioned on a site with SSL).
If validation succeeds, then the services provisioned will commence.
All other operations on the site, such as modifyAccount,provisionAddon, modifyAddon, or deleteAddon, will be permitted.

Request format

There’s a site node in the response XML that corresponds to each siteInformation node in the request XML.

domain: Reiterates domain name
site_id: Reiterates site_id
status: The status of the request
The following fields serve as confirmation that the earlier provisioned credits were applied to the site.
- subscription (or bundle)
  - Product ID of the SiteLock Scan plan or Bundle that was provisioned on this site. Identical to the subscription or bundle nodes returned from provisionAccount.
subscription_id: Unique ID for a SiteLock subscription (not a product ID).

Notes

This special modifyAccount call can only be made once on a SiteLock site, and only if the site was earlier created through provisionAccount without specifying a domain name (for example, it can only be called once on a parked site, and it cannot be used to update the name of the domain on which SiteLock is already providing services).
A partner may specify multiple siteInformation nodes in the same request XML, one for each site that is being converted from a parked site to a regular site. The response XML will contain corresponding site nodes.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <modifyAccount>
        <siteInformation>
            <id>100005102</id>
            <domain>zunkus04.sitelock.com</domain>
            <trusted_domain>yes</trusted_domain>
            <domain_email>[email protected]</domain_email>
        </siteInformation>
    </modifyAccount>
</SiteLockOnlineRequest>

Response format

Example success response

<SiteLockOnlineResponse>
    <result>Site(s) updated</result>
    <site>
        <domain>zunkus04.sitelock.com</domain>
        <site_id>100005102</site_id>
        <status>ok</status>
        <subscription>47</subscription>
        <subscription_id>1615162</subscription_id>
    </site>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <error>Site 100005096 not eligible for domain renaming </error>
</SiteLockOnlineResponse>

Possible errors

The site_id isn’t eligible for domain renaming (either the site has never been a parked site, or has already been converted to a regular site).
No subscriptions associated with site site_id.
Invalid domain for site_id (failed the valid domain name check).
Domain already in use, requires a unique domain for site’s site_id.
Other error messages: Any error that the provisionAccount or provisionAddon call may return.