Overview
Error Handling

Methods

API Documentation (API Version bleed)

Account/

DESCRIPTION

This section contains methods to order an account (or order new services for an existing account), and to get details about an account.

These methods are not exposed to api users; this functionality can only be accessed though the management user interface.

adCampaigns

URL:

https://api.liquidweb.com/bleed/Account/adCampaigns

Description:

Ad campaign information for a given account.

Parameters:

No Values Defined

Returns:

FieldType
campaignsAn array of associative arrays containing
 
customer_portal_ad_image_urlA string permitting tabs, carriage returns and newlines* Optional
customer_portal_ad_link_urlA string permitting tabs, carriage returns and newlines* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.liquidweb.com/bleed/Account/details

Description:

Returns account details.

Parameters:

ParameterType
alsowithAn array of One of: 'accountContact', 'businessUnit', 'customerLifecycle', 'highlights', 'managementPortal', 'mrc', 'referAFriend'

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
account_statusA single word, consisting of only letters and digits.
levelA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

getVisitCycles

URL:

https://api.liquidweb.com/bleed/Account/getVisitCycles

Description:

Returns the date ranges for the current, previous, and previous previous visit cycles.

Note: This is calculated based on current visit billing date. If the billing date has been changed in the last three months, this may be inaccurate.

Parameters:

No Values Defined

Returns:

FieldType
cyclesAn array of associative arrays containing
 
periodA positive integer value (i.e. 1 and up).
periodBeginAn ISO8601 extended format date and time: 2013-09-29T10:40Z.
periodEndAn ISO8601 extended format date and time: 2013-09-29T10:40Z.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

highlights

URL:

https://api.liquidweb.com/bleed/Account/highlights

Description:

Retrieve Highlights from account

Parameters:

No Values Defined

Returns:

FieldType
highlightsAn array of associative arrays containing
 
countA non-negative integer value (i.e. 0 and up).
keyOne of: 'migrations', 'secure-notes'

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

invoicesAndPaymentsTimeline

URL:

https://api.liquidweb.com/bleed/Account/invoicesAndPaymentsTimeline

Description:

List of invoices and payments for the account sorted by created date descending (i.e., most recent first)

Parameters:

ParameterTypeNotes
begin_dateA valid date in YYYY-MM-DD format.
end_dateA valid date in YYYY-MM-DD format.
invoice_idA valid id number (a positive integer).
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
titleOne of: 'invoice', 'payment'

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
balanceA monetary value, such as -$.05, 0.05, or -5.00* Optional
created_onA valid date and time in YYYY-MM-DD HH:MM:SS format.
display_amountA monetary value, such as -$.05, 0.05, or -5.00
idA valid id number (a positive integer).
remainingA monetary value, such as -$.05, 0.05, or -5.00
titleOne of: 'invoice', 'payment'
typeA string consisting of only letters, digits, hyphens, spaces, and underscores.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

level

URL:

https://api.liquidweb.com/bleed/Account/level

Description:

Returns the account's level.

Parameters:

No Values Defined

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
levelA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

order

URL:

https://api.liquidweb.com/bleed/Account/order

Description:

Place an order for services creating a new account.

Parameters:

ParameterTypeNotes
addressA valid street address, up to 150 characters in length.* Required
address2A valid street address, up to 150 characters in length.
attributionAn array of associative arrays containing
 
sourceA string of text, containing no newlines or other control characters.* Required
source_dataAn associative array of arbitrary keys and values.* Required
cardCodeThe cvv code of a credit card, consisting of a number at least 3 digits and up to 4 digits in length (i.e. 1234, 010, etc).
cartAn associative array of arbitrary keys and values.* Required
cityA valid city name.* Required
cjaidA string of text, containing no newlines or other control characters.
cjsidA string of text, containing no newlines or other control characters.
companyA valid company name, up to 100 characters in length.
countryA valid ISO country code.* Required
couponA 6 to 40 character coupon code
customer_uuidA valid UUID (Universally Unique IDentifier).* Required if:
  • paymentMethod is set to 'creditCard'
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
emailA valid email address.* Required
faxA valid phone number.
fnameA valid name, up to 100 characters in length.
is_san_orderA boolean value (0 or 1).
is_shared_orderA boolean value (0 or 1).
lnameA valid name, up to 100 characters in length.* Required
opportunity_idA string of text, containing no newlines or other control characters.
passwordA password of at least 6 characters and up to 30 characters in length, may contain spaces* Required
passwordVerifyA password of at least 6 characters and up to 30 characters in length, may contain spaces* Required
paymentIntervalA single word, consisting of only letters and digits.* Required
paymentMethodA single word, consisting of only letters, digits, and underscores.* Required
phoneA valid phone number.* Required
phone_checkA positive integer value (i.e. 1 and up).
phone_codeA non-negative integer value (i.e. 0 and up).
quoteNameA single word, consisting of only letters, digits, hyphens, and underscores.
referredByA string.
referredByTypeA string.
sidA string of text, containing no newlines or other control characters.
stateA valid state or province.
tax_exemptA boolean value (0 or 1).
tax_exempt_idA string of text, containing no newlines or other control characters.* Required if:
  • tax_exempt is set to '1'
tax_exempt_reasonA string of text, containing no newlines or other control characters.* Required if:
  • tax_exempt is set to '1'
tax_idA string of text, containing no newlines or other control characters.* Required if:
  • tax_exempt is set to '1'
traitsAn array of arbitrary values.
userCommentsA string permitting tabs, carriage returns and newlines
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).
validatedA boolean value (0 or 1).
zipA valid postal code.

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
order_idA positive integer value (i.e. 1 and up).
order_typeA string of text, containing no newlines or other control characters.* Optional
pending_configsA non-negative integer value (i.e. 0 and up).
support_passphraseA string permitting tabs, carriage returns and newlines

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

recoverUsername

URL:

https://api.liquidweb.com/bleed/Account/recoverUsername

Description:

Expects either account number or email address. If valid input is given, sends account info email to email address on file.

Parameters:

ParameterTypeNotes
accountA valid account number, up to 6 digits in length.* Required if:
  • email is not given
emailA valid email address.* Required if:
  • account is not given

Returns:

FieldType
submittedA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

signup

URL:

https://api.liquidweb.com/bleed/Account/signup

Description:

New Account Signup handling

Parameters:

ParameterTypeNotes
addressAn associative array containing the fields:* Required
 
addressA valid street address, up to 150 characters in length.* Required
address2A valid street address, up to 150 characters in length.
cityA valid city name.* Required
countryA valid ISO country code.* Required
stateA valid state or province.
validatedA boolean value (0 or 1).* Required
zipA valid postal code.
billingAn associative array containing the fields:
 
tax_exemptA boolean value (0 or 1).
tax_exempt_idA string of text, containing no newlines or other control characters.* Required if:
  • tax_exempt is set to '1'
tax_exempt_reasonA string of text, containing no newlines or other control characters.* Required if:
  • tax_exempt is set to '1'
tax_idA string of text, containing no newlines or other control characters.* Required if:
  • tax_exempt is set to '1'
contactAn associative array containing the fields:* Required
 
emailA valid email address.* Required
faxA valid phone number.
phoneA valid phone number.* Required
extraAn associative array containing the fields:
 
traitsAn array of a single word, consisting of only letters and digits.
identityAn associative array containing the fields:* Required
 
companyA valid company name, up to 100 characters in length.
first_nameA valid name, up to 100 characters in length.* Required
last_nameA valid name, up to 100 characters in length.* Required
preferred_nameA valid name, up to 100 characters in length.

Returns:

FieldType
accntA valid account number, up to 6 digits in length.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

supportSummary

URL:

https://api.liquidweb.com/bleed/Account/supportSummary

Description:

Information related to support for a given account

Parameters:

No Values Defined

Returns:

FieldType
one_time_secretsAn associative array containing the fields:
 
countA non-negative integer value (i.e. 0 and up).
ticketsAn associative array containing the fields:
 
supportAn array of associative arrays containing
 
idA valid identifier for a Salesforce object
last_modified_dateEither: a timestamp formatted according to the xsd:dateTime standard (described in the XML Schema specification); or a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
statusA valid status for cases (e.g. New, Waiting on Customer, etc.).
subjectA string permitting tabs, carriage returns and newlines
ticket_numberA string permitting tabs, carriage returns and newlines

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

upgrade

URL:

https://api.liquidweb.com/bleed/Account/upgrade

Description:

Place an order for services adding services to an existing account.

Parameters:

ParameterTypeNotes
attributionAn array of associative arrays containing
 
sourceA string of text, containing no newlines or other control characters.* Required
source_dataAn associative array of arbitrary keys and values.* Required
cardCodeThe cvv code of a credit card, consisting of a number at least 3 digits and up to 4 digits in length (i.e. 1234, 010, etc).
cartAn associative array of arbitrary keys and values.* Required
cjaidA string of text, containing no newlines or other control characters.
cjsidA string of text, containing no newlines or other control characters.
couponA 6 to 40 character coupon code
customer_uuidA valid UUID (Universally Unique IDentifier).* Required if:
  • paymentMethod is set to 'creditCard'
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
is_san_orderA boolean value (0 or 1).
is_shared_orderA boolean value (0 or 1).
opportunity_idA string of text, containing no newlines or other control characters.
paymentMethodA single word, consisting of only letters, digits, and underscores.
quoteNameA single word, consisting of only letters, digits, hyphens, and underscores.
referredByA string.
referredByTypeA string.
sidA string of text, containing no newlines or other control characters.
traitsAn array of arbitrary values.
userCommentsA string permitting tabs, carriage returns and newlines

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
order_idA positive integer value (i.e. 1 and up).
order_typeA string of text, containing no newlines or other control characters.* Optional
pending_configsA non-negative integer value (i.e. 0 and up).
support_passphraseA string permitting tabs, carriage returns and newlines* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types