Overview
Error Handling

Methods

API Documentation (API Version bleed)

Contact/

DESCRIPTION

This section contains methods to update and manipulate contact data.

create

URL:

https://api.liquidweb.com/bleed/Contact/create

Description:

Create a new contact

Parameters:

ParameterTypeNotes
addressA valid street address, up to 150 characters in length.
address2A valid street address, up to 150 characters in length.
cityA valid city name.
contactA string permitting tabs, carriage returns and newlines
contact_roleOne of: 'individual', 'organization'
contact_role_idA positive integer value (i.e. 1 and up).
countryA valid country.
emailsAn array of associative arrays containing
 
addressA valid email address.* Required
contact_idA valid id number (a positive integer).
idA valid id number (a positive integer).
typeOne of: 'cc', 'main', 'rwhois_main'* Optional
  • Defaults to: cc
fnameA valid name, up to 100 characters in length.* Required
foreign_tax_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
lnameA valid name, up to 100 characters in length.* Required
mnameA string of text, containing no newlines or other control characters.
organizationA valid company name, up to 100 characters in length.
phonesAn array of associative arrays containing
 
contact_idA valid id number (a positive integer).
idA valid id number (a positive integer).
numberA valid phone number.* Required
typeOne of: 'cell', 'fax', 'home', 'office'* Optional
  • Defaults to: office
postal_codeA valid postal code.
socialAn array of associative arrays containing
 
contact_idA valid id number (a positive integer).
handleA string permitting tabs, carriage returns and newlines* Required
idA valid id number (a positive integer).
typeA string permitting tabs, carriage returns and newlines* Required
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'
time_zoneA valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)
titleA string consisting of only letters, digits, hyphens, spaces, and underscores.
typeOne of: 'invoice', 'technical'
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.
validatedA boolean value (0 or 1).

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
addressA valid street address, up to 150 characters in length.* Optional
address2A valid street address, up to 150 characters in length.* Optional
cityA valid city name.* Optional
contactA string permitting tabs, carriage returns and newlines* Optional
contact_roleOne of: 'individual', 'organization'* Optional
contact_role_idA positive integer value (i.e. 1 and up).* Optional
countryA valid country.* Optional
emailsAn array of associative arrays containing * Optional
 
addressA valid email address.
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
typeOne of: 'cc', 'main', 'rwhois_main'* Optional
fnameA valid name, up to 100 characters in length.
foreign_tax_typeA single word, consisting of only letters and digits.* Optional
idA positive integer value (i.e. 1 and up).* Optional
lnameA valid name, up to 100 characters in length.
mnameA string of text, containing no newlines or other control characters.* Optional
organizationA valid company name, up to 100 characters in length.* Optional
phonesAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
numberA valid phone number.
typeOne of: 'cell', 'fax', 'home', 'office'* Optional
postal_codeA valid postal code.* Optional
socialAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
handleA string permitting tabs, carriage returns and newlines
idA valid id number (a positive integer).* Optional
typeA string permitting tabs, carriage returns and newlines
stateA valid state or province.* Optional
tax_exemptA boolean value (0 or 1).* Optional
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'
time_zoneA valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)* Optional
titleA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
typeOne of: 'invoice', 'technical'* Optional
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.* Optional
validatedA boolean value (0 or 1).* Optional

Possible Errors:

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

details

URL:

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

Description:

show the details of one specific contact

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
addressA valid street address, up to 150 characters in length.* Optional
address2A valid street address, up to 150 characters in length.* Optional
cityA valid city name.* Optional
contactA string permitting tabs, carriage returns and newlines* Optional
contact_roleOne of: 'individual', 'organization'* Optional
contact_role_idA positive integer value (i.e. 1 and up).* Optional
countryA valid country.* Optional
emailsAn array of associative arrays containing * Optional
 
addressA valid email address.
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
typeOne of: 'cc', 'main', 'rwhois_main'* Optional
fnameA valid name, up to 100 characters in length.
foreign_tax_typeA single word, consisting of only letters and digits.* Optional
idA positive integer value (i.e. 1 and up).* Optional
lnameA valid name, up to 100 characters in length.
mnameA string of text, containing no newlines or other control characters.* Optional
organizationA valid company name, up to 100 characters in length.* Optional
phonesAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
numberA valid phone number.
typeOne of: 'cell', 'fax', 'home', 'office'* Optional
postal_codeA valid postal code.* Optional
socialAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
handleA string permitting tabs, carriage returns and newlines
idA valid id number (a positive integer).* Optional
typeA string permitting tabs, carriage returns and newlines
stateA valid state or province.* Optional
tax_exemptA boolean value (0 or 1).* Optional
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'
time_zoneA valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)* Optional
titleA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
typeOne of: 'invoice', 'technical'* Optional
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.* Optional
validatedA boolean value (0 or 1).* Optional

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Contact/list

Description:

list all contacts by account

Parameters:

ParameterTypeNotes
addressA string of text, containing no newlines or other control characters.
address2A string of text, containing no newlines or other control characters.
alsowithA single word, consisting of only letters, digits, and underscores.
cityA string of text, containing no newlines or other control characters.
countryA string of text, containing no newlines or other control characters.
emailA string of text, containing no newlines or other control characters.
fnameA string of text, containing no newlines or other control characters.
idA positive integer value (i.e. 1 and up).
ipaddrA valid IP address (v4 or v6)
lnameA string of text, containing no newlines or other control characters.
mnameA string of text, containing no newlines or other control characters.
order_byA valid SQL order by clause (cannot contain any subqueries).
organizationA string of text, containing no newlines or other control characters.
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
phoneA valid phone number.
postal_codeA string of text, containing no newlines or other control characters.
sort_orderOne of: 'ASC', 'DESC', 'asc', 'desc'
stateA string of text, containing no newlines or other control characters.
tax_idA string of text, containing no newlines or other control characters.
time_zoneA valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)

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
 
accntA valid account number, up to 6 digits in length.* Optional
addressA valid street address, up to 150 characters in length.* Optional
address2A valid street address, up to 150 characters in length.* Optional
cityA valid city name.* Optional
contactA string permitting tabs, carriage returns and newlines* Optional
contact_roleOne of: 'individual', 'organization'* Optional
contact_role_idA positive integer value (i.e. 1 and up).* Optional
countryA valid country.* Optional
emailsAn array of associative arrays containing * Optional
 
addressA valid email address.
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
typeOne of: 'cc', 'main', 'rwhois_main'* Optional
fnameA valid name, up to 100 characters in length.
foreign_tax_typeA single word, consisting of only letters and digits.* Optional
idA positive integer value (i.e. 1 and up).* Optional
lnameA valid name, up to 100 characters in length.
mnameA string of text, containing no newlines or other control characters.* Optional
organizationA valid company name, up to 100 characters in length.* Optional
phonesAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
numberA valid phone number.
typeOne of: 'cell', 'fax', 'home', 'office'* Optional
postal_codeA valid postal code.* Optional
socialAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
handleA string permitting tabs, carriage returns and newlines
idA valid id number (a positive integer).* Optional
typeA string permitting tabs, carriage returns and newlines
stateA valid state or province.* Optional
tax_exemptA boolean value (0 or 1).* Optional
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'
time_zoneA valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)* Optional
titleA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
typeOne of: 'invoice', 'technical'* Optional
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.* Optional
validatedA boolean value (0 or 1).* Optional
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

taxExemptReasons

URL:

https://api.liquidweb.com/bleed/Contact/taxExemptReasons

Description:

Retrieve a hash of valid tax exemption reasons, where the key is the code and the value is human-readable description.

Parameters:

No Values Defined

Returns:

FieldType
reasonsAn associative array of arbitrary keys and values.

Possible Errors:

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

update

URL:

https://api.liquidweb.com/bleed/Contact/update

Description:

update a contact given replacement fields for current fields.

Parameters:

ParameterTypeNotes
addressA valid street address, up to 150 characters in length.
address2A valid street address, up to 150 characters in length.
cityA valid city name.
contactA string permitting tabs, carriage returns and newlines
countryA valid country.
emailsAn array of associative arrays containing
 
addressA valid email address.* Required
contact_idA valid id number (a positive integer).
idA valid id number (a positive integer).
typeOne of: 'cc', 'main', 'rwhois_main'* Optional
  • Defaults to: cc
fnameA valid name, up to 100 characters in length.
foreign_tax_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).* Required
lnameA valid name, up to 100 characters in length.
mnameA string of text, containing no newlines or other control characters.
organizationA valid company name, up to 100 characters in length.
phonesAn array of associative arrays containing
 
contact_idA valid id number (a positive integer).
idA valid id number (a positive integer).
numberA valid phone number.* Required
typeOne of: 'cell', 'fax', 'home', 'office'* Optional
  • Defaults to: office
postal_codeA valid postal code.
socialAn array of associative arrays containing
 
contact_idA valid id number (a positive integer).
handleA string permitting tabs, carriage returns and newlines* Required
idA valid id number (a positive integer).
typeA string permitting tabs, carriage returns and newlines* Required
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.
tax_exempt_reasonA string of text, containing no newlines or other control characters.
tax_idA string of text, containing no newlines or other control characters.
time_zoneA valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)
titleA string consisting of only letters, digits, hyphens, spaces, and underscores.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.
validatedA boolean value (0 or 1).

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
addressA valid street address, up to 150 characters in length.* Optional
address2A valid street address, up to 150 characters in length.* Optional
cityA valid city name.* Optional
contactA string permitting tabs, carriage returns and newlines* Optional
contact_roleOne of: 'individual', 'organization'* Optional
contact_role_idA positive integer value (i.e. 1 and up).* Optional
countryA valid country.* Optional
emailsAn array of associative arrays containing * Optional
 
addressA valid email address.
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
typeOne of: 'cc', 'main', 'rwhois_main'* Optional
fnameA valid name, up to 100 characters in length.
foreign_tax_typeA single word, consisting of only letters and digits.* Optional
idA positive integer value (i.e. 1 and up).* Optional
lnameA valid name, up to 100 characters in length.
mnameA string of text, containing no newlines or other control characters.* Optional
organizationA valid company name, up to 100 characters in length.* Optional
phonesAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).* Optional
numberA valid phone number.
typeOne of: 'cell', 'fax', 'home', 'office'* Optional
postal_codeA valid postal code.* Optional
socialAn array of associative arrays containing * Optional
 
contact_idA valid id number (a positive integer).* Optional
handleA string permitting tabs, carriage returns and newlines
idA valid id number (a positive integer).* Optional
typeA string permitting tabs, carriage returns and newlines
stateA valid state or province.* Optional
tax_exemptA boolean value (0 or 1).* Optional
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'
time_zoneA valid timezone with a word, a forward-slash, and another word (e.g. US/Eastern) and any number of trailing forward slashes and words (e.g. America/Argentina/BuenosAires)* Optional
titleA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
typeOne of: 'invoice', 'technical'* Optional
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS-TZ format.* Optional
validatedA boolean value (0 or 1).* Optional

Possible Errors:

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

validateAddress

URL:

https://api.liquidweb.com/bleed/Contact/validateAddress

Description:

Validates a given address -- does not actually change a stored contact.

Returns result 'validated' with the canonical form of the address, if it can be found (US/CA).

Returns result 'success' if the given address could not be improved (it was an international address, or already in canonical form for US/CA).

Throws an error if the US/CA address could not be found, or the country is not recognized, or minimum fields were not supplied.

Parameters:

ParameterType
addressA valid street address, up to 150 characters in length.
address2A valid street address, up to 150 characters in length.
cityA valid city name.
countryA valid country.
postal_codeA valid postal code.
stateA valid state or province.

Returns:

FieldType
addressAn associative array containing the fields:
 
addressA valid street address, up to 150 characters in length.* Optional
address2A valid street address, up to 150 characters in length.* Optional
cityA valid city name.* Optional
countryA valid country.* Optional
postal_codeA valid postal code.* Optional
stateA valid state or province.* Optional
resultOne of: 'success', 'validated'

Possible Errors:

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

validateTaxId

URL:

https://api.liquidweb.com/bleed/Contact/validateTaxId

Description:

allows a user to specify whether their account is a business or individual account, and if it's a business account, validates the tax ID.

Parameters:

ParameterTypeNotes
contact_roleOne of: 'individual', 'organization'* Required
tax_idA string of text, containing no newlines or other control characters.* Required if:
  • contact_role is set to 'organization'

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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