hello,
Overview
Error Handling
Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Basket/Item/Scenario/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Storm/Backup/
- Storm/Config/
- Storm/IP/Pool/
- Storm/Image/
- Storm/Private/Parent/
- Storm/Server/
- Storm/Template/
- Support/Alert/
- Support/Request/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
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.
These methods are not exposed to api users, this functionality can only be accessed though the management user interface.
executeReset
URL:
https://api.liquidweb.com/bleed/Account/ChatPassword/executeReset
Description:
Updates the Support Passphrase for the account associated with the given hash.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| hash | A 27 or 86 character code for a single-use URI | * Required |
| passphrase | A string permitting tabs, carriage returns and newlines | * Required |
Returns:
| Field | Type |
|---|---|
| ok | A 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:
| Field | Type | Notes |
|---|---|---|
| password | A 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:
| Parameter | Type |
|---|---|
| password | A string permitting tabs, carriage returns and newlines |
Returns:
| Field | Type | Notes |
|---|---|---|
| password | A 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:
| Parameter | Type | Notes |
|---|---|---|
| hash | A 27 or 86 character code for a single-use URI | * Required |
Returns:
| Field | Type |
|---|---|
| ok | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
