Overview
Error Handling

Methods

API Documentation (API Version bleed)

Account/ChatPassword/

DESCRIPTION

This section contains methods to update and use an account users support (previously chat) password.

The support password is a phrase that can be used to authenticate with a support technician. It is not considered as sensitive as the account password.

executeReset

URL:

https://api.liquidweb.com/bleed/Account/ChatPassword/executeReset

Description:

Updates the Support Passphrase for the account associated with the given hash.

Parameters:

ParameterTypeNotes
hashA 27 or 86 character code for a single-use URI* Required
passphraseA string permitting tabs, carriage returns and newlines* Required

Returns:

FieldType
okA boolean value (0 or 1).

Possible Errors:

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

get

URL:

https://api.liquidweb.com/bleed/Account/ChatPassword/get

Description:

Returns the support password for the current account and user, if any.

Parameters:

No Values Defined

Returns:

FieldTypeNotes
passwordA string permitting tabs, carriage returns and newlines* Optional

Possible Errors:

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

set

URL:

https://api.liquidweb.com/bleed/Account/ChatPassword/set

Description:

Sets the support password for the current account and user. The support password can be deleted by setting the password field on this method to an empty string.

Parameters:

ParameterType
passwordA string permitting tabs, carriage returns and newlines

Returns:

FieldTypeNotes
passwordA string permitting tabs, carriage returns and newlines* Optional

Possible Errors:

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

visitReset

URL:

https://api.liquidweb.com/bleed/Account/ChatPassword/visitReset

Description:

Returns whether or not the requested link is valid.

Parameters:

ParameterTypeNotes
hashA 27 or 86 character code for a single-use URI* Required

Returns:

FieldType
okA boolean value (0 or 1).

Possible Errors:

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