Actions (127)
Store · 20
- Create domain suggestions queryPOST /api/v2/store/domain/suggestions
Submit a domain suggestions query.
documented - Get a productGET /api/v2/store/product/{product_id}
Retrieve a product by ID.
documented - Get additional fields for TLDGET /api/v2/store/domain/additional-fields/{tld}
Fetch extra fields for a TLD.
documented - Get all TLD pricingGET /api/v2/store/domain/pricing
Retrieve pricing for all TLDs.
documented - Get all product groupsGET /api/v2/store/product-groups
List all product groups.
documented - Get all productsGET /api/v2/store/product
List all products.
documented - Get cross-sell productsGET /api/v2/store/product/{product_id}/cross-sell
List cross-sell products for a product.
documented - Get domain availability (spotlight)GET /api/v2/store/domain/spotlight
Check domain availability for spotlight TLDs.
documented - Get domain registration eligibilityGET /api/v2/store/domain/eligibility
Check eligibility to register a domain.
documented - Get domain suggestion optionsGET /api/v2/store/domain/suggestions
Return available domain suggestion options.
documented - Get product addonsGET /api/v2/store/product/{product_id}/addons
List addons for a product.
documented - Get product bundle detailsGET /api/v2/store/product/bundles
List product bundles.
documented - Get product bundle detailsGET /api/v2/store/product/bundles/{bundle_id}
Details for a product bundle.
documented - Get product configurable optionsGET /api/v2/store/product/{product_id}/config-options
List configurable options for a product.
documented - Get product custom fieldsGET /api/v2/store/product/{product_id}/custom-fields
List custom fields for a product.
documented - Get product group detailsGET /api/v2/store/product-group/{group_id}
Return details for a product group.
documented - Get product pricingGET /api/v2/store/product/{product_id}/pricing
Retrieve pricing for a product.
documented - Get single TLD pricingGET /api/v2/store/domain/pricing/{tld}
Retrieve pricing for a specific TLD.
documented - Get spotlight TLD pricingGET /api/v2/store/domain/spotlight/pricing
Pricing for spotlight TLDs.
documented - Get supported IDN languagesGET /api/v2/store/domain/idn-languages
List Internationalized Domain Name languages.
documented
Cart · 14
- Add cart itemPOST /api/v2/cart/{cart_id}/items
Add an item to a cart.
documented - Apply promo codePOST /api/v2/cart/{cart_id}/promotions
Apply a promo code to a cart.
documented - Begin checkoutPOST /api/v2/cart/{cart_id}/checkout
Start the checkout process for a cart.
documented - Create cart item addonsPOST /api/v2/cart/{cart_id}/items/{item_id}/addons
Add addons to a cart item.
documented - Create cart item domainPOST /api/v2/cart/{cart_id}/items/{item_id}/domain
Associate a domain with a cart item.
documented - Create new cartPOST /api/v2/cart
Create a new shopping cart.
documented - Delete cart itemDELETE /api/v2/cart/{cart_id}/items/{item_id}
Remove an item from a cart.
documented - Delete promo codeDELETE /api/v2/cart/{cart_id}/promotions
Remove a promo code from a cart.
documented - Get all carts for userGET /api/v2/cart
List carts associated with the current user.
documented - Get cart informationGET /api/v2/cart/{cart_id}
Retrieve a specific cart.
documented - Set cart geolocationPOST /api/v2/cart/{cart_id}/geolocation
Set the geolocation for a cart.
documented - Set cart item config optionsPOST /api/v2/cart/{cart_id}/items/{item_id}/pricing-options
Configure options for a cart item.
documented - Update cart itemPOST /api/v2/cart/{cart_id}/items/{item_id}
Update an item in a cart.
documented - Validate cart contentsPOST /api/v2/cart/{cart_id}
Validate the contents of a cart.
documented
Domains · 11
- Domain registerPOST /includes/api.php
Register a new domain.
documented - Domain releasePOST /includes/api.php
Release a domain out of WHMCS.
documented - Domain renewPOST /includes/api.php
Renew a registered domain.
documented - Domain transferPOST /includes/api.php
Transfer a domain to WHMCS.
documented - Get WHOIS infoPOST /includes/api.php
Retrieve WHOIS data for a domain.
documented - Get domain locking statusPOST /includes/api.php
Return whether domain locking is enabled.
documented - Get domain nameserversPOST /includes/api.php
Fetch current domain name servers.
documented - Update WHOIS infoPOST /includes/api.php
Update WHOIS information for a domain.
documented - Update domain locking statusPOST /includes/api.php
Enable or disable domain locking.
documented - Update domain nameserversPOST /includes/api.php
Modify domain name servers.
documented - WHOIS lookupPOST /includes/api.php
Retrieve WHOIS info for a domain.
documented
Module & OAuth · 10
- Activate modulePOST /includes/api.php
Enable a module for use.
documented - Deactivate modulePOST /includes/api.php
Disable a module.
documented - Module change packagePOST /includes/api.php
Change module package.
documented - Module change passwordPOST /includes/api.php
Change module password.
documented - Module createPOST /includes/api.php
Create a new module configuration.
documented - Module queuePOST /includes/api.php
Manage module queue.
documented - Module suspendPOST /includes/api.php
Suspend a module.
documented - Module terminatePOST /includes/api.php
Terminate a module.
documented - Module unsuspendPOST /includes/api.php
Unsuspend a module.
documented - Upgrade productPOST /includes/api.php
Upgrade a product.
documented
Tickets · 7
- Add ticket notePOST /includes/api.php
Add a note to a ticket.
documented - Add ticket replyPOST /includes/api.php
Reply to a ticket.
documented - Delete ticketPOST /includes/api.php
Delete a ticket.
documented - Get ticketPOST /includes/api.php
Retrieve a single ticket.
documented - Get ticketsPOST /includes/api.php
List support tickets.
documented - Open ticketPOST /includes/api.php
Create a new support ticket.
documented - Update ticketPOST /includes/api.php
Update ticket information.
documented
Clients · 6
- Add clientPOST /includes/api.php
Create a new client in WHMCS.
documented - Add client notePOST /includes/api.php
Attach a note to a client record.
documented - Delete clientPOST /includes/api.php
Remove a client from WHMCS.
documented - Get client detailsPOST /includes/api.php
Return detailed information for a specific client.
documented - Get clientsPOST /includes/api.php
Retrieve clients matching criteria (e.g., by name, email).
documented - Update clientPOST /includes/api.php
Update client information.
documented
Invoices · 6
- Add invoice paymentPOST /includes/api.php
Record a payment against an invoice.
documented - Create invoicePOST /includes/api.php
Generate a new invoice.
documented - Delete invoicePOST /includes/api.php
Delete an invoice.
documented - Get invoicePOST /includes/api.php
Retrieve a specific invoice.
documented - Get invoicesPOST /includes/api.php
List invoices based on criteria.
documented - Update invoicePOST /includes/api.php
Modify an existing invoice.
documented
Orders · 6
- Accept orderPOST /includes/api.php
Accept and activate a pending order.
documented - Add orderPOST /includes/api.php
Create a new order in WHMCS.
documented - Fraud orderPOST /includes/api.php
Flag an order as potential fraud.
documented - Get order statusesPOST /includes/api.php
List possible order statuses.
documented - Get ordersPOST /includes/api.php
List orders.
documented - Pending orderPOST /includes/api.php
Mark an order as pending.
documented
Admin · 5
- Create client masqueradePOST /api/v2/admin/clients/masquerade
Masquerade as a client in the admin interface.
documented - Create user masqueradePOST /api/v2/admin/users/masquerade
Masquerade as a user in the admin interface.
documented - Get clients by searchGET /api/v2/admin/clients/search
Search clients as an admin.
documented - Get system statusGET /api/v2/admin/system/status
Retrieve the admin system status.
documented - Get users by searchGET /api/v2/admin/users/search
Search admin users.
documented
Projects · 5
- Create projectPOST /includes/api.php
Create a new project.
documented - Delete projectPOST /includes/api.php
Delete a project.
documented - Get projectPOST /includes/api.php
Retrieve a project.
documented - Get projectsPOST /includes/api.php
List projects.
documented - Update projectPOST /includes/api.php
Update project information.
documented
User · 5
- Create user sessionPOST /api/v2/user/session
Log a user in and obtain a session.
documented - End user sessionDELETE /api/v2/user/session
Log the user out and end the session.
documented - Get user clientsGET /api/v2/user/clients
List clients for the authenticated user.
documented - Submit user 2FA responsePOST /api/v2/user/session/verify
Verify Two-Factor Authentication for user login.
documented - Update active clientPUT /api/v2/user/clients/{client_id}
Change the active client in the session.
documented
Announcements · 4
OAuth & API Keys · 4
- Create OAuth credentialPOST /includes/api.php
Create an OAuth credential for API access.
documented - Delete OAuth credentialPOST /includes/api.php
Delete an OAuth credential.
documented - List OAuth credentialsPOST /includes/api.php
List existing OAuth credentials.
documented - Update OAuth credentialPOST /includes/api.php
Update an OAuth credential.
documented