Overview
Error Handling

Methods

API Documentation (API Version bleed)

Support/Request/

DESCRIPTION

Methods for Support Requests.

authenticate

URL:

https://api.liquidweb.com/bleed/Support/Request/authenticate

Description:

Links a case to a given account and marks it as authenticated

Parameters:

ParameterTypeNotes
idA valid identifier for a Salesforce object* Required
usernameA username up to 20 characters in length if active or 24 if suspended.

Returns:

FieldType
authenticatedA boolean value (0 or 1).
typeOne of: 'case', 'livechattranscript'

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/Support/Request/create

Description:

Create a Support Request Case.

Parameters:

ParameterTypeNotes
authenticatedA boolean value (0 or 1).
authentication_statusA valid authentication status for case, livechats (Authenticated, Unauthenticated).
authenticatorA username up to 20 characters in length if active or 24 if suspended.
case_owner_idA valid identifier for a Salesforce object
descriptionA string permitting tabs, carriage returns and newlines
handoff_noteA string permitting tabs, carriage returns and newlines
priorityA valid priority for case
queueA string of text, containing no newlines or other control characters.
record_typeA string of text, containing no newlines or other control characters.
statusA valid status for cases (e.g. New, Waiting on Customer, etc.).* Optional
  • Defaults to: New
sub_typeA string of text, containing no newlines or other control characters.
subjectA string of text, containing no newlines or other control characters.
ticket_numberA string permitting tabs, carriage returns and newlines
typeA string of text, containing no newlines or other control characters.
user_ownerA string of text, containing no newlines or other control characters.
zendesk_ticket_idA string permitting tabs, carriage returns and newlines

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
acknowledgedA boolean value (0 or 1).* Optional
acknowledged_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.* Required if:
  • acknowledge is set to '1'
authenticatedA boolean value (0 or 1).* Optional
authentication_statusA valid authentication status for case, livechats (Authenticated, Unauthenticated).* Optional
authenticatorA username up to 20 characters in length if active or 24 if suspended.* Optional
case_originA string of text, containing no newlines or other control characters.* Optional
case_owner_idA valid identifier for a Salesforce object* Optional
change_eventsA string permitting tabs, carriage returns and newlines* Optional
departmentA string permitting tabs, carriage returns and newlines* Optional
descriptionA string permitting tabs, carriage returns and newlines* Optional
handoff_noteA string permitting tabs, carriage returns and newlines* Optional
idA valid identifier for a Salesforce object
priorityA valid priority for case* Optional
queueA string of text, containing no newlines or other control characters.* Optional
record_typeA string of text, containing no newlines or other control characters.* Optional
record_type_idA valid identifier for a Salesforce object* Optional
salesforce_accountA valid identifier for a Salesforce object* Optional
salesforce_contactA valid identifier for a Salesforce object* Optional
statusA valid status for cases (e.g. New, Waiting on Customer, etc.).* Optional
sub_typeA string permitting tabs, carriage returns and newlines* Optional
subjectA string permitting tabs, carriage returns and newlines* Optional
ticket_numberA string permitting tabs, carriage returns and newlines* Optional
typeA string of text, containing no newlines or other control characters.* Optional
user_ownerA string of text, containing no newlines or other control characters.* Optional
zendesk_ticket_idA 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/Support/Request/details

Description:

Returns case details.

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'chats', 'comments', 'emails'
idA valid identifier for a Salesforce object* Required if:
  • ticket_number is not given
ticket_numberA string permitting tabs, carriage returns and newlines* Required if:
  • id is not given

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
acknowledgedA boolean value (0 or 1).* Optional
acknowledged_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.* Required if:
  • acknowledge is set to '1'
authenticatedA boolean value (0 or 1).* Optional
authentication_statusA valid authentication status for case, livechats (Authenticated, Unauthenticated).* Optional
authenticatorA username up to 20 characters in length if active or 24 if suspended.* Optional
case_originA string of text, containing no newlines or other control characters.* Optional
case_owner_idA valid identifier for a Salesforce object* Optional
change_eventsA string permitting tabs, carriage returns and newlines* Optional
departmentA string permitting tabs, carriage returns and newlines* Optional
descriptionA string permitting tabs, carriage returns and newlines* Optional
handoff_noteA string permitting tabs, carriage returns and newlines* Optional
idA valid identifier for a Salesforce object
priorityA valid priority for case* Optional
queueA string of text, containing no newlines or other control characters.* Optional
record_typeA string of text, containing no newlines or other control characters.* Optional
record_type_idA valid identifier for a Salesforce object* Optional
salesforce_accountA valid identifier for a Salesforce object* Optional
salesforce_contactA valid identifier for a Salesforce object* Optional
statusA valid status for cases (e.g. New, Waiting on Customer, etc.).* Optional
sub_typeA string permitting tabs, carriage returns and newlines* Optional
subjectA string permitting tabs, carriage returns and newlines* Optional
ticket_numberA string permitting tabs, carriage returns and newlines* Optional
typeA string of text, containing no newlines or other control characters.* Optional
user_ownerA string of text, containing no newlines or other control characters.* Optional
zendesk_ticket_idA string permitting tabs, carriage returns and newlines* Optional

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Support/Request/list

Description:

Get a list of support request cases.

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'chats', 'comments', 'emails'
order_byAn associative array containing the fields:
 
fieldThe value: 'LastModifiedDate'* Optional
  • Defaults to: LastModifiedDate
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
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
statusA standardized search for a valid status for cases (e.g. New, Waiting on Customer, etc.).

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
acknowledgedA boolean value (0 or 1).* Optional
acknowledged_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.* Required if:
  • acknowledge is set to '1'
authenticatedA boolean value (0 or 1).* Optional
authentication_statusA valid authentication status for case, livechats (Authenticated, Unauthenticated).* Optional
authenticatorA username up to 20 characters in length if active or 24 if suspended.* Optional
case_originA string of text, containing no newlines or other control characters.* Optional
case_owner_idA valid identifier for a Salesforce object* Optional
change_eventsA string permitting tabs, carriage returns and newlines* Optional
departmentA string permitting tabs, carriage returns and newlines* Optional
descriptionA string permitting tabs, carriage returns and newlines* Optional
handoff_noteA string permitting tabs, carriage returns and newlines* Optional
idA valid identifier for a Salesforce object
priorityA valid priority for case* Optional
queueA string of text, containing no newlines or other control characters.* Optional
record_typeA string of text, containing no newlines or other control characters.* Optional
record_type_idA valid identifier for a Salesforce object* Optional
salesforce_accountA valid identifier for a Salesforce object* Optional
salesforce_contactA valid identifier for a Salesforce object* Optional
statusA valid status for cases (e.g. New, Waiting on Customer, etc.).* Optional
sub_typeA string permitting tabs, carriage returns and newlines* Optional
subjectA string permitting tabs, carriage returns and newlines* Optional
ticket_numberA string permitting tabs, carriage returns and newlines* Optional
typeA string of text, containing no newlines or other control characters.* Optional
user_ownerA string of text, containing no newlines or other control characters.* Optional
zendesk_ticket_idA string permitting tabs, carriage returns and newlines* 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

reply

URL:

https://api.liquidweb.com/bleed/Support/Request/reply

Description:

Public API that wraps the internal salesforce addComment method.

Note that the 'body' is the equivelent of the 'comment' field in salesforce

Parameters:

ParameterTypeNotes
commentA string permitting tabs, carriage returns and newlines* Required
idA valid identifier for a Salesforce object* Required

Returns:

FieldType
commentA string permitting tabs, carriage returns and newlines
idA valid identifier for a Salesforce object

Possible Errors:

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