API - API Reference

Accept Order

Accept Order. Requires AcceptOrder API permission.

POST https://your-domain-name/rapi/AcceptOrder

Parameters

Field

Type

Optional

Description

token

text

Required

order_id

int

Required

The specific server to assign to products within the order

server_id

int

Optional

Server ID will be auto applied if empty

service_action

string

Optional

Service Actions as CA, SWE, CASWE
CA eq Create Account
SWE eq Send Welcome Email
CASWE eq Create Account & Send Welcome Email
By default value is CASWE

send_registrar

string

Optional

Domain Actions as STR, SCE, STRSCE
STR eq Send to Registrar
SCE eq Send Confirmation Email
SRTSCE eq Send to Registrar & Send Confirmation Email
By default value is SRTSCE

Accept Quote

Accept Quote. Requires AcceptQuote API permission.

POST https://your-domain-name/rapi/AcceptQuote

Parameters

Field

Type

Optional

Description

token

text

Required

quote_id

number

Required

The specific server to assign to products within the order

Add Announcement

Add an announcement.

POST https://your-domain-name/rapi/AddAnnouncement

Parameters

Field

Type

Optional

Description

token

text

Required

entry_date

datetime

Required

Date in the format YYYY-MM-DD HH:MM:SS

title

string

Required

announcement_text

string

Required

Announcement text

published

bool

Optional

Pass as true to publish

Add Banned IP

Add an IP to the ban list.

POST https://your-domain-name/rapi/AddBannedIp

Parameters

Field

Type

Optional

Description

token

text

Required

ip_address

string

Required

reason

string

Required

Admin only reason

days

int

Required

If passed, expires date is auto calculated

expires

datetime

Optional

YYYY-MM-DD HH:MM:SS

Add Cancellation Request

Add a Cancellation Request

POST https://your-domain-name/rapi/AddCancelRequest

Parameters

Field

Type

Optional

Description

token

text

Required

service_id

int

Required

The Service ID to cancel

type

string

Optional

The type of cancellation. Immediate or End of Billing Period

cancel_domain

string

Optional

Cancel associated domain if exist

reason

string

Optional

The customer reason for cancellation

Add Client

Add a client.

POST https://your-domain-name/rapi/AddClient

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Optional

The ID of the user that should own the client. Optional. When not provided, a new user will be created.

first_name

string

Required

First name of the client to be created.

last_name

string

Required

Last name of the client to be created.

company_name

string

Optional

email

string

Required

Email address of the client to be created.

address1

string

Required

address2

string

Optional

city

string

Required

state

string

Required

postcode

string

Required

country

string

Required

2 character ISO country code.

phonenumber

string

Required

tax_id

string

Optional

The clients tax ID.

password

string

Optional

The password for the newly-created user account.

security_qid

int

Optional

The ID of the security question in tbladminsecurityquestions.

security_qans

string

Optional

The security question answer for a newly-created user.

currency

int

Optional

Currency ID from currencies.

group_id

int

Optional

Client Group ID from tblclientgroups.

custom_fields

string

Optional

Base64 encoded serialized array of custom field values.

language

string

Optional

Default language setting. Also used for the language of the user when owner_user_id is not specified. Provide the full name: english, french, etc.

user_ip

string

Optional

The originating IP address for the request.

notes

string

Optional

Admin only notes.

marketing_emails_opt_in

bool

Optional

Whether the client should opt-in to receiving marketing emails.

send_mail

bool

Optional

Whether to send the client a welcome email. A true value will not send the email.

Add Client Note

Add a Client Note

POST https://your-domain-name/rapi/AddClientNote

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The Client ID to apply the note to

notes

string

Required

The note to add

sticky

bool

Optional

Should the note be made sticky. Makes the note sticky and displays the note throughout the clients account and on any tickets they submit in the admin area

Add Contact

Add a contact to a client account.

POST https://your-domain-name/rapi/AddContact

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

first_name

string

Optional

last_name

string

Optional

company_name

string

Optional

email

string

Optional

Email address to identify the contact. This should be unique if the contact will be a sub-account

address1

string

Optional

address2

string

Optional

city

string

Optional

state

string

Optional

postcode

string

Optional

country

string

Optional

2 character ISO country code

phonenumber

string

Optional

tax_id

string

Optional

password

string

Optional

The new password for the contact

permissions

array

Optional

An array of the permissions to grant the contact

general_emails

bool

Optional

Should the client receive general emails

product_emails

bool

Optional

Should the client receive product emails

domain_emails

bool

Optional

Should the client receive domain emails

invoice_emails

bool

Optional

Should the client receive invoice emails

support_emails

bool

Optional

Should the client receive support emails

affiliate_emails

bool

Optional

Should the client receive affiliate emails

Add credit to a given client.

Add credit to a given client. Requires AddCredit API permission.

POST https://your-domain-name/rapi/AddCredit

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client to add credit to.

description

string

Required

Admin only notes for credit justification.

amount

float

Required

The amount of credit to add or remove. Must be a positive value.

entry_date

string

Optional

The date the credit was added. YYYY-mm-dd format.

admin_id

int

Optional

The active admin ID to be associated with the credit record. Defaults to current admin.

Add Funds invoice

Add Funds invoice for specific client

POST https://your-domain-name/rapi/AddFunds

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client

amount

float

Required

The funds amount value

Add payment to a given invoice.

Add payment to a given invoice. Requires AddInvoicePayment API permission.

POST https://your-domain-name/rapi/AddInvoicePayment

Parameters

Field

Type

Optional

Description

token

text

Required

invoice_id

int

Required

The ID of the invoice to add payment to.

trans_id

string

Optional

The unique transaction ID that should be applied to the payment.

gateway_id

int

Optional

The gateway used, in system id format (e.g., 1 or 2 or 3), gateway_id can get from Apps & Integration > Installed/Active Apps > Payment Gateways Apps. and Click at Configure Icon to View Gateway ID

entry_date

string

Optional

The date that the payment should have assigned. Format: YYYY-MM-DD HH:mm:ss

amount

float

Optional

The amount paid. You can leave this undefined to take the full amount of the invoice.

fees

float

Optional

The amount of the payment that was taken as a fee by the gateway.

do_not_send_email

string

Optional

Set this to true to prevent sending an email for the invoice payment.

Add an order to a client.

Add an order to a client. Requires AddOrder API permission.

POST https://your-domain-name/rapi/AddOrder

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client to add the order for.

payment_method

string

Required

The payment method for the order in the system format (e.g., paypal, mailin).

no_invoice

string

Optional

Set to YES to suppress the invoice generating for the whole order. Possible values YES or NO

no_invoice_email

string

Optional

Set to YES to suppress the Invoice Created email being sent for the order. Possible values YES or NO

do_not_send_email

string

Optional

Set to YES to suppress the Order Confirmation email being sent. Possible values YES or NO

user_ip

string

Required

The IP address to associate with the order.

userAgent

string

Required

The User Agent to associate with the order from $_SERVER["HTTP_USER_AGENT"]

acceptLanguage

string

Required

The acceptLanguage to associate with the order from $_SERVER["HTTP_ACCEPT_LANGUAGE"]

notes

string

Optional

The Notes for order.

Client Add Payment Method Form

Add Payment Method Form for specific user/client account.

POST https://your-domain-name/rapi/AddPayMethodForm

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The Unique Client ID

Add Product

Add a product to the system to be available for purchase

POST https://your-domain-name/rapi/AddProduct

Parameters

Field

Type

Optional

Description

token

text

Required

title

string

Required

The name of the product to be added

highlight_text

string

Optional

The highlight text of the product to display prominently on order forms in (Ribbens)

description

string

Optional

The description of the product, You may use HTML in this field for New lines, Bold, Bold Italics, Italic and other tags

notes

string

Optional

The product notes, You may use HTML in this field for New lines, Bold, Bold Italics, Italic and other tags

gid

int

Required

The id of the product group to add the product

slug

string

Optional

The friendly name of the product. Will be generated if not supplied.

tid

int

Required

Unique type id which mentioned in GetProductsTypes API Request

is_stock_control

string

Optional

Set to YES to enable stock control on the product, Default NO and options are YES or NO

unit_in_stock

int

Optional

How much of this product is in stock

payment_time

string

Optional

The payment type of the product. One of free, onetime, recurring, default value recurring is not entered in API request

price_duration

string

Required

The Default Price Duration for the product. One option should filled in API request from mentioned Options (price_monthly_fee, price_quarterly_fee, price_semi_annually_fee, price_annually_fee, price_biennially_fee, price_triennially_fee, price_four_years_fee, price_five_years_fee, price_six_years_fee, price_seven_years_fee, price_eight_years_fee, price_nine_years_fee, price_ten_years_fee)

cost

float

Required

The product cost price required based on selected default price duration for calcuations of Profit & Loss

setup_pricing

JSON

Required

JSON input required for product setup pricing based on base currency as

[{"price_monthly_fee":"0",  "price_quarterly_fee":"0",  "price_semi_annually_fee":"10",  "price_annually_fee":"20",  "price_biennially_fee":"40"}]

You can choose to include or omit the pricing key and its value.
Example:
If you don't want to apply a monthly price to this product, there's no need to include the price_monthly_fee key and its value, and vice versa.
Keys are mentioned in price_duration which required for pricing

old_pricing

JSON

Required

JSON input required for product old pricing based on base currency as

[{"price_monthly_fee":"0",  "price_quarterly_fee":"0",  "price_semi_annually_fee":"10",  "price_annually_fee":"20",  "price_biennially_fee":"40"}]

You can choose to include or omit the pricing key and its value.
Example:
If you don't want to apply a monthly price to this product, there's no need to include the price_monthly_fee key and its value, and vice versa.
Keys are mentioned in price_duration which required for pricing

sale_pricing

JSON

Required

JSON input required for product sale pricing based on base currency as

[{"price_monthly_fee":"0",  "price_quarterly_fee":"0",  "price_semi_annually_fee":"10",  "price_annually_fee":"20",  "price_biennially_fee":"40"}]

You can choose to include or omit the pricing key and its value.
Example:
If you don't want to apply a monthly price to this product, there's no need to include the price_monthly_fee key and its value, and vice versa.
Keys are mentioned in price_duration which required for pricing

is_hidden

string

Optional

Should the product be hidden from the client order form, Default NO and options are YES or NO

server_config_option_show

string

Optional

Only VPS/Dedicated Server Configuration options not visible to end users, Default NO and options are YES or NO

apply_tax

string

Optional

Does tax apply to the product, Default NO and options are YES or NO

recurring_cycles_limit

number

Optional

To limit this product to only recur a fixed number of times, enter the total number of times to invoice (0 = Unlimited)

auto_terminate_days

number

Optional

Enter the number of days after activation to automatically terminate (eg. free trials, time limited products, etc...)

auto_terminate_email

int

Optional

The id of the Email Template to use as the terminate email. Product/Service Messages only

eid_welcome

int

Optional

The id of the Email Template to use as the welcome email. Product/Service Messages only

prorata_billing_enable

string

Optional

Is pro-rata billing enabled for this product, Default NO and options are YES or NO

prorata_billing_day

int

Optional

Enter the day of the month you want to charge on

charge_next_month

int

Optional

Enter the day of the month after which the following month will also be included on the first invoice

product_setup_after

string

Optional

When should the product be automatically setup. One of PAYMENT_RECEIPT (on payment received), ORDER_PLACED (when order placed), ORDER_ACCEPTTED (when order accept manually), MANUALLY (Do not automatically setup this product)

server_type

string

Required

The server module system name to associate with the product. eg: cpanel, autorelease, plesk

server_group_id

int

Optional

The server group id used on product creation to associate an appropriate server

server_package_name

string

Optional

The package name from the server which id metioned in request, incase of server not required for the product then no need for the value of server_package_name

orderby

int

Optional

The order to in which to display on the order form

subdomain_options

string

Optional

Enter in the format example.com, abc.com (comma seperated list supported for multiple options) to offer on the domain register page.

domain_registration_option

string

Optional

Should the product show the domain registration options, Default NO and options are YES or NO

free_domain

string

Optional

Offer a free domain registration or renewal, Default NONE and options are NONE, FREE_WO_RENEWAL or FREE_W_RENEWAL

NONE = No Free Registration/Renewal and Transfer
FREE_WO_RENEWAL = Offer a free domain registration/transfer only (renew as normal)
FREE_W_RENEWAL = Offer a free domain registration/transfer and free renewal (if product is renewed)

free_domain_period

string

Optional

Free Domain Payment Terms, Comma Separated terms allowerd as (Free, price_onetime_fee, price_monthly_fee, price_quarterly_fee, price_semi_annually_fee, price_four_years_fee, price_five_years_fee, price_six_years_fee, price_seven_years_fee, price_eight_years_fee, price_nine_years_fee, price_ten_years_fee)

Free = Free Account
price_onetime_fee = One Time
price_monthly_fee = Monthly
price_quarterly_fee = Quarterly
price_semi_annually_fee = Semi-Annually
price_four_years_fee = 4-Year
price_five_years_fee = 5-Year
price_six_years_fee = 6-Year
price_seven_years_fee = 7-Year
price_eight_years_fee = 8-Year
price_nine_years_fee = 9-Year
price_ten_years_fee = 10-Year

free_domain_tlds

string

Optional

Comma Separated TLDs which allowed for free with this product as mentioned (com, pk, net, org) e.g

product_upgrade_plans

string

Optional

Comma Separated Products IDs which will be marked as upgrade, means user can place an upgrade order from small hosting or servers plan to large plan within same product groups

product_upgrade_email

int

Optional

Unique Email template ID for upgrade notification to customer on successful upgrade

product_upgrade_plans_enable

string

Optional

Enable to allow Upgrading/Downgrading of upgrade options, Default NO and options are YES or NO

products_config_groups

string

Optional

Comma Separated Configureable options groups IDs which will be display in cart for selection

custom_affiliate_payout

string

Optional

Enable Custom Affiliate Commission payout, Default (No Commission) and options are (Use Default, Percentage, Fixed Amount, No Commission)

is_affiliate_payout_type

string

Optional

Enable Affiliate Commission payout type, Default (One Time) and options are (One Time, Recurring)

affiliate_pay_amount

float

Optional

Affiliate Pay Amount in numeric values

is_overages_billing

string

Optional

Enable Overages usage Billing, Default (DISABLE) and options are (ENABLE, DISABLE)

disk_usage_limits

float

Optional

Disk Usage Soft limits in numeric values

disk_usage_limits_unit

string

Optional

Select Disk Overages usage Billing Size unit, Default (MB) and options are (MB, GB, TB)

disk_usage_limits_cost

float

Optional

Disk Usage Cost as per Usage Size per Unit based on base currency

bandwidth_usage_limits

float

Optional

Bandwidth Usage Soft limits in numeric values

bandwidth_usage_limits_unit

string

Optional

Select Bandwidth Overages usage Billing Size unit, Default (MB) and options are (MB, GB, TB)

bandwidth_usage_limits_cost

float

Optional

Bandwidth Usage Cost as per Usage Size per Unit based on base currency

configurations

JSON

Optional

Custom Configurations in JSON format and it will available in product details and at the time of provisioning modules execution

Add Product Group

Add a product group to the system

POST https://your-domain-name/rapi/AddProductGroup

Parameters

Field

Type

Optional

Description

token

text

Required

title

string

Required

The title of the group to be added

headline

string

Required

The head line of the group (Select Your Perfect Plan) eg.

tagline

string

Required

The Tag line of the group (With our 30 Day Money Back Guarantee You Can't Go Wrong!) eg.

suggestion

string

Optional

Yes to Offer services against domains at cart page and NO for Not Display.

default_group

string

Optional

Yes to mark this group as default products group for cart/order page in clientarea.

link

string

Optional

Product Group Custom Link for Services/Products Displayed, You can any link of 3rd party or your site page link

hidden

string

Optional

Group Hidden means, Hidden group or its products/services will not display to clients, YES eq to Hidden, NO eq to Not hidden

order_template

string

Optional

Order Template required to display products/serives in store page as per selection.

Add Refund

Add a Refund transaction to the system

POST https://your-domain-name/rapi/AddRefund

Parameters

Field

Type

Optional

Description

token

text

Required

invoice_id

int

Required

The ID of the invoice the transaction is for

transaction_id

int

Required

The unique transaction id for this payment

entry_date

string

Optional

The date of the transaction in your Localisation Format (eg DD/MM/YYYY)

amount

float

Optional

The refund amount to be refunded, if empty then Transaction amount will be refunded

refund_type

string

Optional

Refund type as Manual, Credit or Gateway, Default Credit

Add Security Question

Add security questions in system for clients to use

POST https://your-domain-name/rapi/AddSecurityQuestion

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

question

string

Required

Security Question

Add Ticket Note

Add a note to a ticket by Ticket ID or Ticket Number.

POST https://your-domain-name/rapi/AddTicketNote

Parameters

Field

Type

Optional

Description

token

text

Required

ticket_id

int

Optional

The id of the ticket in the database. Either $ticket_id is required

admin_id

int

Required

The id of the admin in the database. Either $admin_id is required

message

string

Required

The content of the ticket note

attachments

array

Optional

Optional base64 json encoded array of file attachments. Can be the direct output of a multipart-form-data form submission ($_FILES superglobal in PHP).

Add Ticket Reply

Add a reply to a ticket by Ticket ID.

POST https://your-domain-name/rapi/AddTicketReply

Parameters

Field

Type

Optional

Description

token

text

Required

ticket_id

int

Required

The id of the ticket in the database. $ticket_id is required

user_id

int

Optional

Pass a user_id to associate the ticket reply with a specific client

admin_id

int

Optional

Pass a admin_id to associate the ticket reply with a specific admin

message

string

Required

The content of the ticket reply

attachments

array

Optional

Optional base64-encoded JSON array of files. Each file must be an object with keys: `name`, `type`, `size`, `tmp_name`. `tmp_name` should contain base64-encoded content using `file_get_contents`.
Example:

$attachments = [];
$attachments[] = [
  'name' => 'file.pdf', 
  'type' => 'application/pdf', 
  'size' => 12345, 
  'tmp_name' => base64_encode(file_get_contents($tmpFilePath))
];
$encoded = base64_encode(json_encode($attachments));

Send the encoded string as the value of this field.

Add User

Add a user.

POST https://your-domain-name/rapi/AddUser

Parameters

Field

Type

Optional

Description

token

text

Required

first_name

string

Required

last_name

string

Required

email

string

Required

password

string

Required

The password for the newly created user account

language

string

Optional

Default language setting. Provide full name: 'english', 'french', etc...

Affiliate Activate

Activate affiliate referrals for a client.

POST https://your-domain-name/rapi/AffiliateActivate

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The client ID to activate affiliate status for

Apply Credit

Applies the Clients Credit to an invoice

POST https://your-domain-name/rapi/ApplyCredit

Parameters

Field

Type

Optional

Description

token

text

Required

invoice_id

int

Required

The ID of the invoice to apply credit

amount

float

Optional

The amount of credit to apply to the invoice.

do_not_send_email

string

Optional

Set to true to stop the invoice payment email being sent if the invoice becomes paid

Apply Promo Code

Apply Promo Code to Cart

POST https://your-domain-name/rapi/ApplyPromotion

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The Client unique ID

code

string

Required

Promo code which will applied to cart

client_ip_address

string

Required

The Client system ip address

Block Ticket Sender

Blocks a ticket sender.

POST https://your-domain-name/rapi/BlockTicketSender

Parameters

Field

Type

Optional

Description

token

text

Required

ticket_id

int

Required

The ticket the sender opened

delete

string

Optional

Should the ticket also be deleted, For Deletion YES else NO

Payment gateway callback response

Payment gateway callback response sent to API for payment verification and invoice marking as paid

POST https://your-domain-name/rapi/CallPaymentGateway

Parameters

Field

Type

Optional

Description

token

text

Required

invoice_id

int

Required

The Unique invoice id

gateway_id

string

Required

The payment gateway id or name

CallBackResponse

array

Required

The clientarea payment form generated data on click at paynow button at invoice page

Cancel Order

Cancel a Pending Order

POST https://your-domain-name/rapi/CancelOrder

Parameters

Field

Type

Optional

Description

token

text

Required

order_id

int

Required

The ID of the pending order

subscription_cancel

string

Optional

Attempt to cancel the subscription associated with the products

do_not_send_email

string

Optional

Set to true to stop the invoice payment email being sent if the invoice becomes paid

Capture Payment

Attempt to capture a payment on an unpaid CC Invoice

POST https://your-domain-name/rapi/CapturePayment

Parameters

Field

Type

Optional

Description

token

text

Required

invoice_id

int

Required

The ID of the pending invoice

Capture Payment by Invoice

Attempt to capture a payment on an unpaid Invoice by clicking paynow button

POST https://your-domain-name/rapi/CapturePaymentByInvoice

Parameters

Field

Type

Optional

Description

token

text

Required

FormData

json

Required

The clientarea payment form generated data on click at paynow button at invoice page, $_POST data encode to json via json_encode then encode to base64 via base64_encode and sent to api

Register Domain add to cart

Domain add to cart for Register.

POST https://your-domain-name/rapi/CartAddDomain

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain

string

Required

The name of the domain to register recommended

hosting

int

Optional

The Unique Service/Hosting/Package ID

user_id

int

Optional

The Unique Client ID

client_ip_address

string

Required

The Client system ip address

Own Domain add to cart

Own Domain add to cart for hosting/product attachment.

POST https://your-domain-name/rapi/CartAddDomainOwned

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain

string

Required

The domain name of the domain to be transferred recommended

hosting

int

Optional

The hosting/product cart id for domain attachment with hosting/product

user_id

int

Optional

The Unique Client ID

client_ip_address

string

Required

The Client system ip address

Renew Domain add to cart

Domain add to cart for domain renewal to us.

POST https://your-domain-name/rapi/CartAddDomainRenew

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The domain id of the domain to be renewed recommended

user_id

int

Optional

The Unique Client ID

client_ip_address

string

Required

The Client system ip address

Transfer Domain add to cart

Domain add to cart for domain transfer to us.

POST https://your-domain-name/rapi/CartAddDomainTransfer

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain

string

Required

The domain name of the domain to be transferred recommended

eppcode

string

Required

Provide a new EPP Code for the Transfer Request

hosting

int

Optional

The hosting/product cart id for domain attachment with hosting/product

user_id

int

Optional

The Unique Client ID

client_ip_address

string

Required

The Client system ip address

Cart Add Item

Add item to cart

POST https://your-domain-name/rapi/CartAddItem

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

hosting

int

Required

The Unique Service/Hosting/Package ID

duration

string

Optional

The duration type

user_id

int

Optional

The Unique Client ID

client_ip_address

string

Required

The Client system ip address

Change Billing duration

Change Item Billing duration in cart

POST https://your-domain-name/rapi/CartChangeDuration

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The Unique Cart Item ID

user_id

int

Optional

The Unique Client ID

cycle

string

Required

Duration name

client_ip_address

string

Required

The Client system ip address

Delete Cart Item

Delete item from cart

POST https://your-domain-name/rapi/CartDeleteItem

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The Unique Cart Item ID

Update Addon options

Update Addon options in cart

POST https://your-domain-name/rapi/CartUpdateAddonOptions

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The Unique Cart Item ID

clientid

int

Optional

The Unique Client ID

addon

int

Required

The Unique addon ID

act

string

Required

Add or Del - Addon add to cart against specific item or remove

client_ip_address

string

Required

Client system IP address

Update Configs options

Update Configs options in cart

POST https://your-domain-name/rapi/CartUpdateConfigOption

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The Unique Cart Item ID

clientid

int

Optional

The Unique Client ID

group

int

Required

The Unique Group ID

config

int

Required

The Unique Config ID

client_ip_address

string

Required

Client system IP address

Update Domain Configs

Update Domain Configs in cart

POST https://your-domain-name/rapi/CartUpdateDomainConfigs

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The Unique Cart Item ID

dns1

string

Optional

Name server 1 for Domain

dns2

string

Optional

Name server 2 for Domain

dns3

string

Optional

Name server 3 for Domain

dns4

string

Optional

Name server 4 for Domain

dns5

string

Optional

Name server 5 for Domain

additional

json

Optional

Additional fields Array to JSON values with respective keys

Update Server Configs

Update Server Configs in cart

POST https://your-domain-name/rapi/CartUpdateSvrConfigs

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The Unique Cart Item ID

hostname

string

Optional

Hostname for Server

root_password

string

Optional

Root password for Server

name_server_one

string

Optional

Name Server 1

name_server_two

string

Optional

Name Server 2

customfields

json

Optional

Custom fields Array to JSON values with respective keys

Verify Own Domain add to cart

Own Domain add to cart for hosting/product attachment after verification.

POST https://your-domain-name/rapi/CartVerifyDomainOwned

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain

string

Required

The domain name of the domain to be transferred recommended

Change Client Password

POST https://your-domain-name/rapi/ChangeClientPassword

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The Client ID to apply the note to

old_pwd

string

Required

Client or User Old/Current password

new_pwd

string

Required

Client or User New password

new_pwd_cfm

string

Required

Client or User New password as Confirm Password

Change Client Security Question

Change Client Security Question as extra Security layer for verification to use when client want to forget password

POST https://your-domain-name/rapi/ChangeClientSecurityQuestion

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The Client ID to apply the note to

old_question_answer

string

Required

Client or User Old Question Answer

question

int

Required

Client or User New Question Unique ID

answer

string

Required

Client or User New Question Answer

Client Do Email Verification

Do email verification for specific user/client account.

POST https://your-domain-name/rapi/ClientDoEmailVerification

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

key

string

Required

The verification key

Client Send Verification Email

Send email for account verification for specific user/client.

POST https://your-domain-name/rapi/ClientSendVerificationEmail

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The id of the user/client

Client Signup

Client Signup via signup page.

POST https://your-domain-name/rapi/ClientSignup

Parameters

Field

Type

Optional

Description

token

text

Required

first_name

string

Required

First name of the client to be created.

last_name

string

Required

Last name of the client to be created.

company_name

string

Optional

email

string

Required

Email address of the client to be created.

address1

string

Required

address2

string

Optional

city

string

Required

state

string

Required

postcode

string

Required

country

string

Required

2 character ISO country code.

phonenumber

string

Required

tax_id

string

Optional

The clients tax ID.

security_qid

int

Optional

The ID of the security question in tbladminsecurityquestions.

security_qans

string

Optional

The security question answer for a newly-created user.

currency

int

Optional

Currency ID from currencies.

custom_fields

string

Optional

Base64 encoded serialized array of custom field values.

language

string

Optional

Default language setting. Also used for the language of the user when owner_user_id is not specified. Provide the full name: english, french, etc.

user_ip

string

Optional

The originating IP address for the request.

notes

string

Optional

Admin only notes.

marketing_emails_opt_in

bool

Optional

Whether the client should opt-in to receiving marketing emails.

send_mail

bool

Optional

Whether to send the client a welcome email. A true value will not send the email.

Close Client

Close a Client.

POST https://your-domain-name/rapi/CloseClient

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client to close

Create Funds Invoice

Create an fund invoice using the provided parameters for client.

POST https://your-domain-name/rapi/CreateFundsInvoice

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client to create the invoice for.

amount

float

Required

Funds value as amount to be added in invoice for client to add funds

Create Invoice

Create an invoice using the provided parameters.

POST https://your-domain-name/rapi/CreateInvoice

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client to create the invoice for.

status

int

Optional

The status unique id for invoice being created. Defaults to 1, Status mentioned as (1 = Draft, 2 = UnPaid, 3 = Paid)

send_invoice

string

Optional

Whether to send the Invoice Created Email to the client. Value as YES or NO, Default Value is NO

payment_method

int

Optional

The Unique ID of payment method for invoice creation.

line_items

json

Required

An JSON Data of line items in the invoice as mentioned.

If you want to add predefined client service or domain then no need for name and cost values, just add servoce_id for service or domain_id for client existing domain.
If you want to apply current price of serice/domain then no need for rate values else add rate value in API request
Discount Values mentioned as percentage
Rate/Cost value for single Qty, so system will calculate total cost and sale value automatically

Example:[{"service_id":12, "qty":1, "rate":10, "discount":5}, {"domain_id":16, "qty":1, "rate":10, "discount":0}, {"name":"Test 2", "qty":2, "cost":16, "rate":20, "discount":10}]

notes

string

Optional

The notes to appear on the created invoice.

auto_apply_credit

string

Optional

Whether to automatically apply credit from the client account to the invoice.Value as YES or NO, Default Value is NO

Creates a new quote

POST https://your-domain-name/rapi/CreateQuote

Parameters

Field

Type

Optional

Description

token

text

Required

subject

string

Required

The subject of the new quote

date_created

string

Optional

The date the quote was created in localised format (DD/MM/YYYY)

date_expiry

string

Required

The date the quote is valid until in localised format (DD/MM/YYYY)

status

string

Optional

The status of Quote as mentioned (Draft, Delivered, On Hold, Accepted, Lost, Dead, Cancelled) Default Status is Draft

client_id

int

Optional

The client ID the quote is for existing client, If client_id empty then client details should be entered in request

first_name

string

Optional

The first name of the client

last_name

string

Optional

The last name of the client

company

string

Optional

The company of the client

email

string

Optional

The email address of the client

address1

string

Optional

The address1 of the client

address2

string

Optional

The address2 of the client

city

string

Optional

The city of the client

state

string

Optional

The state of the client

post_code

string

Optional

The post code of the client

country

string

Optional

The country of the client

phone_number

string

Optional

The phone number of the client

currency

int

Optional

The id of the currency for the quote

line_items

json

Required

An JSON Data of line items in the quote as mentioned, Example:[{"name":"Test 1", "qty":1, "rate":10, "discount":5}, {"name":"Test 2", "qty":2, "rate":20, "discount":10}, {"name":"Test 3", "qty":1, "rate":30, "discount":0}]

proposal_notes

string

Optional

The proposal text displayed to the end user

customer_notes

string

Optional

The notes on the quote displayed to the end user

admin_notes

string

Optional

The notes on the quote displayed to the staff only

Create a TLD Extension

Create a TLD Extension.a new TLD will be created.
Prices should based on Base Currency because other currencies prices will be updated automatically.

POST https://your-domain-name/rapi/CreateTLD

Parameters

Field

Type

Optional

Description

token

text

Required

TLD

string

Required

The extension to add (e.g., .com, .net, etc.)

IDP

string

Optional

Offer ID Protection for the extension

DNS

string

Optional

Offer DNS Management for the extension

EF

string

Optional

Offer Email Forwarding for the extension

EPP

string

Optional

Is an EPP required for domain transfers

SUG

string

Optional

Enable for Auto Suggestions

SPOT

string

Optional

If enabled as Spotlight then TLD will be showing at Domain Registration page as prominent.

SWSE

string

Optional

If enabled then Who's verification button will be showing to clients and clients can send whoi's verification email

REG

string

Required

The active registrar for automatic registration as (onlinenic, cosmos, connectreseller)

default_registration_period_price_off_from_cart

string

Required

if Domain TLD Free with any Service based on terms which is selected in Service/Product Configuration and Client Selected Different Registration Period of Domain then Price will be Off

voucher_required

string

Required

Vouchers/Prepaid Cards Required means, specific tld will be register/renew using voucher/prepaid card if added in whasols.

default_registration_period

string

Required

The Default registration period for TLD

FET

string

Optional

Specify a group label ('Free', 'HOT', 'NEW', 'SALE')

featured_color

string

Optional

TLD Featured will be showing at client side with selected color instead of None.

grace_days

int

Optional

The number of days for the grace period

grace_cost

float

Optional

The grace period fee cost for the extension

grace_fee

float

Optional

The grace period fee selling price for the extension

redemption_days

int

Optional

The number of days for the redemption period

redemption_cost

float

Optional

The redemption period cost for the extension

redemption_fee

float

Optional

The redemption period sellect price for the extension

cost

float

Required

TLD Cost, Based on Default Registration Period

register

string

Required

Comma Separated registration pricing as 10, 20, 30 so and so. (Maximum 10 values allowed), System will consider 1st value for 1 year, 2nd for 2 years and so and so.

renew

Parameters

Field

Type

Optional

Description

token

text

Required

service_id

int

Required

The Service ID to cancel

Delete a client

delete a client. Removes client record and all associated data.

POST https://your-domain-name/rapi/DeleteClient

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The client id to be deleted

Delete Client Note

Delete a Client Note

POST https://your-domain-name/rapi/DeleteClientNote

Parameters

Field

Type

Optional

Description

token

text

Required

id

int

Required

The Client Note ID to delete the note

Delete a contact

Delete a contact. Removes contact record.

POST https://your-domain-name/rapi/DeleteContact

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The client id of contact

contact_id

int

Required

The contact id to be deleted

Remove credit from a client.

Remove credit from a client. Requires DeleteCredit API permission.

POST https://your-domain-name/rapi/DeleteCredit

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client to delete credit to.

description

string

Required

Admin only notes for credit justification.

amount

float

Required

The amount of credit to remove. Must be a positive value.

entry_date

string

Optional

The date the credit was deleted. YYYY-mm-dd format.

Delete a cancelled or fraud order

Delete a cancelled or fraud order. Removes all associated items (services, addons, domains, invoices, etc).

POST https://your-domain-name/rapi/DeleteOrder

Parameters

Field

Type

Optional

Description

token

text

Required

order_id

int

Required

The order to be deleted

Delete a Pay Method

Delete a Pay Method.

POST https://your-domain-name/rapi/DeletePayMethod

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The id of the client matching the Pay Method

payment_method_id

int

Required

The id of the Pay Method to delete

Delete Payment Transaction

Delete a Payment Transaction from the system

POST https://your-domain-name/rapi/DeletePaymentTransaction

Parameters

Field

Type

Optional

Description

token

text

Required

transaction_id

int

Required

The unique transaction id of the payment transactio entry

Delete Product

Delete a product from system

POST https://your-domain-name/rapi/DeleteProduct

Parameters

Field

Type

Optional

Description

token

text

Required

id

int

Required

The unique ID of the product to be deleted

Delete Product Group

Delete a product group from system

POST https://your-domain-name/rapi/DeleteProductGroup

Parameters

Field

Type

Optional

Description

token

text

Required

gid

int

Required

The unique ID of the group to be deleted

Delete Quote

Delete a quote from the system. This action cannot be undone.

POST https://your-domain-name/rapi/DeleteQuote

Parameters

Field

Type

Optional

Description

token

text

Required

quote_id

int

Required

The quote id to be deleted.

Delete Security Question

Delete security questions from system

POST https://your-domain-name/rapi/DeleteSecurityQuestion

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

question_id

int

Required

Security Question Unique ID

Delete Ticket

Delete a ticket and all its replies from the system. This action cannot be undone.

POST https://your-domain-name/rapi/DeleteTicket

Parameters

Field

Type

Optional

Description

token

text

Required

ticket_id

int

Required

Comma separated tickets ids to be deleted as 1 or 1, 2, 3.

Delete Ticket Note

Delete a ticket note from the system. This action cannot be undone.

POST https://your-domain-name/rapi/DeleteTicketNote

Parameters

Field

Type

Optional

Description

token

text

Required

note_id

int

Required

The ticket note id to be deleted.

Delete Ticket Reply

Delete a specific ticket reply from the system. This action cannot be undone.

POST https://your-domain-name/rapi/DeleteTicketReply

Parameters

Field

Type

Optional

Description

token

text

Required

reply_id

int

Required

The ticket reply id to be deleted.

Delete User Client Relationship

Deletes the relationship between a user and a client.

POST https://your-domain-name/rapi/DeleteUserClient

Parameters

Field

Type

Optional

Description

token

text

Required

client_id

int

Required

The id of the client from which to remove the user.

user_id

int

Required

The id of the user to remove from the client.

Activate 2FA Module

Activate 2FA Module for Specific Client.

POST https://your-domain-name/rapi/DoActivateTwoFaMod

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

Client ID for activation request of 2FA

module

string

Required

2FA Module name for activation for a specific client

secret

string

Optional

2FA Module secret for activation for a specific client

code

string

Required

2FA Module code for activation for a specific client

Send affiliate application request

send affiliate application request for affiliate account activation

POST https://your-domain-name/rapi/DoAffiliateRequest

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

FormData

json

Required

The clientarea affiliate form generated data at Affiliates page, $_POST data encode to json via json_encode then encode to base64 via base64_encode and sent to api

Deactivate 2FA Module

Deactivate the Client 2FA Module.

POST https://your-domain-name/rapi/DoDeactivateTwoFaMod

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

Client ID for deactivation of 2FA

password

string

Required

Client password for deactivation of 2FA Modules for a specific client id

Domain Custom Actions

execute custom actions against specific domain

POST https://your-domain-name/rapi/DoDomainCustomActions

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client id to obtain the details for

FormData

json

Required

The clientarea form generated data at domain details, $_POST data encode to json via json_encode then encode to base64 via base64_encode and sent to api

Api Key Credential Deletion

API Key Deletion based on req parameters

POST https://your-domain-name/rapi/DoResellerApiKeyDelete

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The unique clientarea API Key id for API key deletion

Api Key Credential Create/Update

API Key Generation data submit to API for Credential updation or creation

POST https://your-domain-name/rapi/DoResellerApiKeySave

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

FormData

json

Required

The clientarea API Key form generated data at API Keys, $_POST data encode to json via json_encode then encode to base64 via base64_encode and sent to api

IP Access Removal

Reseller IP Access Removal by unique ID

POST https://your-domain-name/rapi/DoResellerIpDelete

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The unique clientarea IP id for IP deletion

Reseller IP Save

IP Access Restriction to use our reseller API

POST https://your-domain-name/rapi/DoResellerIpSave

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The unique client id

FormData

json

Required

The clientarea IP form generated data at Reseller IPs, $_POST data encode to json via json_encode then encode to base64 via base64_encode and sent to api

Send 2FA Module Request

Send 2FA Module Request for activation the Client 2FA Module.

POST https://your-domain-name/rapi/DoSendTwoFaMod

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

Client ID for activation request of 2FA

module

string

Required

2FA Module name for activation request for a specific client id

Service Custom Actions

execute custom actions against specific Service

POST https://your-domain-name/rapi/DoServiceCustomActions

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client id to obtain the details for

FormData

json

Required

The clientarea form generated data at service details, $_POST data encode to json via json_encode then encode to base64 via base64_encode and sent to api

Do 2FA Verification

Do 2FA Verification for specific client after signin.

POST https://your-domain-name/rapi/DoTwoFaVerification

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

Client ID for verification of 2FA

code

string

Required

Client 2FA Input text for verification of 2FA

Get Domain Locking Status

Connects to the registrar and obtains the current lock status of the domain.

POST https://your-domain-name/rapi/DomainGetLockingStatus

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to obtain the lock status for

Get Domain Nameservers

Connects to the registrar and obtains the nameservers for the domain.

POST https://your-domain-name/rapi/DomainGetNameservers

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to obtain the nameservers for

Get Domain Whois Information

Connects to the registrar and obtains the whois information for the domain.

POST https://your-domain-name/rapi/DomainGetWhoisInfo

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain

string

Required

The domain to obtain the whois information for

Register Domain

Connects to the registrar and attempts to register the domain.

POST https://your-domain-name/rapi/DomainRegister

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to register recommended

ns1

int

Optional

The Name Server of the domain for DNS

ns2

int

Optional

The Name Server of the domain for DNS

ns3

int

Optional

The Name Server of the domain for DNS

ns4

int

Optional

The Name Server of the domain for DNS

Renew Domain

Connects to the registrar and attempts to renew the domain.

POST https://your-domain-name/rapi/DomainRenew

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Optional

The id of the domain to be renewed recommended

duration

int

Optional

How long to renew the domain for. Defaults to the current stored value.

Request EPP Code

Connects to the registrar and attempts to obtain the EPP Code for the domain.

POST https://your-domain-name/rapi/DomainRequestEPP

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to obtain the EPP for

Domain Availablity checking

Domain Availablity checking, its availabe for registration or not

POST https://your-domain-name/rapi/DomainSearch

Parameters

Field

Type

Optional

Description

token

text

Required

domain

string

Required

The Domain name for checking, its available or not

hosting

int

Optional

The Hosting/Product Unique ID Domain attachment with hosting/Product in cart

Domain Spotlights Availablity checking

Domain Spotlights Availablity checking, its availabe for registration or not

POST https://your-domain-name/rapi/DomainSpotlights

Parameters

Field

Type

Optional

Description

token

text

Required

domain

string

Required

The Domain name for checking, its available or not

Transfer Domain

Connects to the registrar and attempts to start the transfer process.

POST https://your-domain-name/rapi/DomainTransfer

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to be transferred recommended

epp_code

string

Required

Provide a new EPP Code for the Transfer Request

Update Locking Status

Connects to the registrar and attempts to update the lock.

POST https://your-domain-name/rapi/DomainUpdateLockingStatus

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to update the locking status for

lock_status

string

Required

Should the domain lock be turned on

Update Nameservers

Connects to the registrar and attempts to update the nameservers with those provided.

POST https://your-domain-name/rapi/DomainUpdateNameservers

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to update the nameservers for recommended

ns1

string

Required

The first nameserver

ns2

string

Required

The second nameserver

ns3

string

Optional

The third nameserver

ns4

string

Optional

The fourth nameserver

ns5

string

Optional

The fifth nameserver

Update Whois Information

Connects to the registrar and attempts to update the WHOIS Information.

POST https://your-domain-name/rapi/DomainUpdateWhoisInfo

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The id of the domain to update the whois information for

whois_info

string

Required

The json of the details to update. See DomainGetWhoisInfo

Deuplicate Product

Deuplicate a product to the system

POST https://your-domain-name/rapi/DuplicateProduct

Parameters

Field

Type

Optional

Description

token

text

Required

title

string

Required

The title of the duplicate product as New Product Title

pid

int

Required

The unique ID of the selected/existing product to be duplicate

gid

int

Required

The unique ID of the group for product duplicate creation under this group

is_hidden

string

Optional

A hidden product is not visible to end users, YES eq to Hidden, NO eq to Display to end users

Encrypt Password

Encrypting the same string twice will return different values. You will need to decrypt an encrypted string to compare values.

POST https://your-domain-name/rapi/EncryptPassword

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

password

string

Required

The string to encrypt

Forgot Password

Starts the password Forgot process for a user.

POST https://your-domain-name/rapi/ForgotPassword

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

email

string

Required

The email of the user/client to forgot password

Mark Fraudulent Order

Marks an order as fraudulent.

POST https://your-domain-name/rapi/FraudOrder

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

order_id

int

Required

The Order ID to set as fraud

subscription_cancel

string

Optional

Pass as true to cancel any PayPal Subscription(s) associated with the products & services that belong to the given order.

Generate Invoices

Generate any invoices that are due to be generated.

POST https://your-domain-name/rapi/GenInvoices

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

Pass to generate invoices only for a single client id

Generate Support Pincode

Generate Support Pincode for support

POST https://your-domain-name/rapi/GenerateSupportPin

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The Client unique ID

Get Activity Log

Obtain the Activity Log that matches passed criteria.

POST https://your-domain-name/rapi/GetActivityLog

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Required

The page number as 1

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, userid, timestamp, user, ipaddr

userid

int

Optional

The ID of the client to obtain the log for.

timestamp

string

Optional

The date of the activity log to retrieve in localised format (eg 01/01/2016)

user

string

Optional

The client email, user email, or admin username to retrieve the log entries for.

description

string

Optional

Search the log for a specific string

ipaddr

string

Optional

The IP Address to search the activity log for

Get Admin Details

Obtain the details for the Admin User.

POST https://your-domain-name/rapi/GetAdminDetails

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

admin_id

int

Required

Admin Unique ID for

Get Admin Users

Retrieve a list of administrator user accounts.

POST https://your-domain-name/rapi/GetAdminUsers

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

group_id

int

Optional

An administrative role ID to filter for.

email

string

Optional

An email address to filter for. Partial matching supported.

Get Affiliate Form Fields

Obtain an array of affiliate form fields for client request submittion

POST https://your-domain-name/rapi/GetAffiliateFormFields

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

Obtain affiliate data for a specific client account

days

int

Optional

Obtain affiliate data for a specific client account

Get Affiliates

Obtain an array of affiliates

POST https://your-domain-name/rapi/GetAffiliates

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, first_name, last_name, company_name, email, groupid, datecreated, status

user_id

int

Optional

Obtain affiliate data for a specific client account

reffers

int

Optional

Provide affiliates that match a specific visitor count

country

string

Optional

Provide affiliates matching the country provided

entry_date

string

Optional

Provide affiliates matching a specific entry_date

balance

float

Optional

Provide affiliates that have this balance

withdrawn

float

Optional

Provide affiliates that have withdrawn this amount

Get Announcement

Obtain an array of announcement

POST https://your-domain-name/rapi/GetAnnouncement

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

Announcement Unique Id

Get Announcements

Obtain an array of announcements

POST https://your-domain-name/rapi/GetAnnouncements

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get Automation Log

Get Automation Task Log.

POST https://your-domain-name/rapi/GetAutomationLog

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

entry_date

string

Required

Defaults to today

Get Cancelled Packages

Obtain an array of cancellation requests

POST https://your-domain-name/rapi/GetCancelledPackages

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, type, status, cancellation_date, product_type

type

string

Optional

The column to type of request as Immediate or End of Billing Period

status

string

Optional

The column to status of request as Completed or Pending

cancellation_date

string

Optional

The column to cancellation_date of request

Get Complete Cart

Get shopping cart complete items with details

POST https://your-domain-name/rapi/GetCart

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Optional

The client unique ID as user_id

user_ip

string

Required

The IP address to associate with the order.

Get Cart Mini Summary

Get shopping cart mini summary with cart items count

POST https://your-domain-name/rapi/GetCartSummary

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Optional

The client unique ID as user_id

user_ip

string

Required

The IP address to associate with the order.

Get Client Groups

int

Required

The user_id to obtain the password for

Get Clients

Obtain the Clients that match passed criteria

POST https://your-domain-name/rapi/GetClients

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Required

The page number as 1

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, first_name, last_name, company_name, email, groupid, datecreated, status

status

string

Optional

Optional desired Client Status. Active, Inactive, or Closed

first_name

string

Optional

The search term to look for at the start of first_name

last_name

string

Optional

The search term to look for at the start of last_name

company_name

string

Optional

The search term to look for at the start of company_name

email

string

Optional

The search term to look for at the start of email

phonenumber

string

Optional

The search term to look for at the start of phonenumber

entry_date

string

Optional

The search term to look for at the start of creation date

Get Client Details

Obtain the Clients Details for a specific client.

POST https://your-domain-name/rapi/GetClientDetails

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Optional

The client id to obtain the details for. $user_id or $email is required

email

string

Optional

The email address of the client to search for

stats

bool

Optional

Also return additional client statistics

Get Client specific Domain

Obtain a details of Client Domain matching the provided criteria.

POST https://your-domain-name/rapi/GetClientDomain

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client id to obtain the details for

domain_id

int

Required

The domain id to obtain the details for

page_name

string

Required

The page_name as (di, dc, dpns, dmns) di=domain information, dc=domain contact details, dpns=domain private dns, dmns=domain name servers managment

Get Client Domains

Obtain a list of Client Purchased Domains matching the provided criteria.

POST https://your-domain-name/rapi/GetClientDomains

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client id to obtain the details for

status

string

Optional

The domains via status

Get Client Product/Service details

obtain client product/service details based on req parameters.

POST https://your-domain-name/rapi/GetClientProduct

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client id to obtain the details for

service_id

int

Required

The unique service id to obtain the details for

page_name

string

Required

The page_name as (cp, rc, si) si=service information, cp=change password, rc=cancellation request

Get Client Products

Obtain a list of Client Purchased Products matching the provided criteria.

POST https://your-domain-name/rapi/GetClientProducts

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client id to obtain the details for

Get Client Stats

Obtain a list of Client Stats matching the provided criteria.

POST https://your-domain-name/rapi/GetClientsStats

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client id to obtain the details for

Get Configuration Value

Retrieve a System Configuration Value.

POST https://your-domain-name/rapi/GetConfigurationValue

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

setting

string

Required

The name of the setting to be obtained

Get Contact Information

Obtain the Client Contact information.

POST https://your-domain-name/rapi/GetContact

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

contact_id

int

Optional

Find contact for a specific contact id

Get Contacts

Obtain the Client Contacts that match passed criteria.

POST https://your-domain-name/rapi/GetContacts

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Required

The page number as 1

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The Records soring by order field name

sort_order

string

Optional

The Records soring by order ASC or DESC

user_id

int

Optional

Find contacts for a specific client id

first_name

string

Optional

Find contacts with a specific first name

last_name

string

Optional

Find contacts with a specific last name

company_name

string

Optional

Find contacts with a specific company name

email

string

Optional

Find contacts with a specific email address

address1

string

Optional

Find contacts with a specific address line 1

address2

string

Optional

Find contacts with a specific address line 2

city

string

Optional

Find contacts with a specific city

state

string

Optional

Find contacts with a specific state

postcode

string

Optional

Find contacts with a specific post/zip code

country

string

Optional

Find contacts with a specific country

phonenumber

string

Optional

Find contacts with a specific phone number

Get Credits

Obtain the Credit Log for a Client Account.

POST https://your-domain-name/rapi/GetCredits

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, entry_date

user_id

int

Required

The Client to obtain the log for

Get Currencies

Obtain the Currencies configured in the System.

POST https://your-domain-name/rapi/GetCurrencies

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get Email Info

Obtain a info of email sent to a specific Client ID.

POST https://your-domain-name/rapi/GetEmailInfo

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Required

The unique ID to retrieve the email info

Get Email Templates

Obtain a list of email templates from the system.

POST https://your-domain-name/rapi/GetEmailTemplates

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

id

int

Optional

The id of email template to retrieve specific template

command

string

Optional

The name of email template to retrieve specific template

welcome_email

string

Optional

The welcome_email of email template to retrieve specific template related to send clients when products/services/domains created, YES/NO

type

string

Optional

The type of email template to retrieve

Get Emails

Obtain a list of emails sent to a specific Client ID.

POST https://your-domain-name/rapi/GetEmails

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The client ID to retrieve the emails for

page_num

int

Required

The page number as 1

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, subject, user_id, from_email, datetime, to, sent

datetime

string

Optional

The date to retrieve emails for. Format: Y-m-d H:i:s

subject

string

Optional

The subject to retrieve emails for (uses approximate string matching)

Get Funds page info

Get Funds page info for specific client

POST https://your-domain-name/rapi/GetFundsInfo

Parameters

Field

Type

Optional

Description

token

text

Required

user_id

int

Required

The ID of the client

Get Head,Header & Footer Hooks output

POST https://your-domain-name/rapi/GetHeaderFooterHooks

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get Invoice

Retrieve a specific invoice.

POST https://your-domain-name/rapi/GetInvoice

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

invoice_id

int

Required

The ID of the invoice to retrieve

Get Invoices

Retrieve a list of invoices.

POST https://your-domain-name/rapi/GetInvoices

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, user_id, status, cancellation_date, product_type

user_id

int

Optional

Find invoices for a specific client id

status

string

Optional

Find invoices for a specific status. Standard Invoice statuses plus Overdue

entry_date

string

Optional

Find invoices for a specific entry_date

due_date

string

Optional

Find invoices for a specific due_date

paid_date

string

Optional

Find invoices for a specific paid_date

Get Module Configuration Parameters

Obtains the Module Configuration Parameters.

POST https://your-domain-name/rapi/GetModuleConfigurationParameters

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

module_type

string

Required

The module type to be activated, Module Types as (builtin, addon, domain, server, security, payment, exchange, email, sms, theme, auth_signin)

module_name

string

Required

The module name to be activated

Get Module Queue

Obtains the Module Queue for Incomplete Failed Actions.

POST https://your-domain-name/rapi/GetModuleQueue

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

related_id

int

Optional

The id of the service to load. Used in conjunction with $serviceType

type

string

Optional

The type of service to load (hosting, other, services, config, domain-transfer, domain-register, domain-renewal, domain, server, reseller))

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, user_id, status, cancellation_date, product_type

order_no

int

Optional

Find orders for a specific order

user_id

int

Optional

Find orders for a specific client id

invoice_id

int

Optional

Find orders for a specific Invoice id

status

string

Optional

Find orders for a specific status

ip_address

string

Optional

Find orders for a specific IP Address

Get Parameters

This command can be used to fetch system parameters using api token.

POST https://your-domain-name/rapi/GetParameters

Parameters

Field

Type

Optional

Description

token

text

Required

Manage API Credentials

Get Pay Methods

Obtain the Pay Methods associated with a provided client id.

POST https://your-domain-name/rapi/GetPayMethods

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The id of the client to obtain the Pay Methods for

id

int

Optional

The id of a specific Pay Method to retrieve

Get Payment Methods

Required

Manage API Credentials

code

string

Optional

Find promotions by the specified code

type

string

Optional

Find promotions by the specified type

Get Quotes

Obtain quotes matching the passed criteria.

POST https://your-domain-name/rapi/GetQuotes

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, user_id, status, cancellation_date, product_type

id

int

Optional

Find quotes for a specific id

user_id

int

Optional

Find quotes for a specific client id

status

string

Optional

Find quotes for a specific status

date_created

string

Optional

Find quotes created on a specific date. Format: Y-m-d

last_modified

string

Optional

Find quotes last modified on a specific date. Format: Y-m-d

valid_until

string

Optional

Find quotes valid until a specific date. Format: Y-m-d

Get Registrars

Get Registrars.

POST https://your-domain-name/rapi/GetRegistrars

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get Reseller API Form

obtain Reseller API Form via client id.

POST https://your-domain-name/rapi/GetResellerApiForm

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

clientid

int

Required

The client id to obtain the details for

id

int

Optional

The unique id to obtain the details for of existing API key for updation

Get Reseller API keys

obtain Reseller API keys via client id.

POST https://your-domain-name/rapi/GetResellerApis

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

clientid

int

Required

The client id to obtain the details for

Get Reseller IPs

obtain Reseller IPs via client id.

POST https://your-domain-name/rapi/GetResellerIPs

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

clientid

int

Required

The client id to obtain the details for

Get Reseller IP Access Form

obtain Reseller IP Access Form.

POST https://your-domain-name/rapi/GetResellerIpForm

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get Reseller Products Prices

Get Reseller Products Prices via client id

POST https://your-domain-name/rapi/GetResellerProductsPrices

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The unique client id for prices fetching

Get Reseller Tld Prices

Get Reseller Domain Tlds Prices via client id

POST https://your-domain-name/rapi/GetResellerTldPrices

Parameters

Field

Type

Optional

Description

Field

Type

Optional

Description

Field

Type

Optional

Description

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

ticket_id

int

Optional

A specific ticket ID to find tickets for is required)

Get Ticket Attachment

Retrieve a single attachment. Retrieves a single attachment from a ticket, reply or note with filename and base64 encoded file contents.

POST https://your-domain-name/rapi/GetTicketAttachment

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

ticket_id

int

Required

The unique id of the ticket to get

reply_id

int

Optional

The unique id of the reply to get

attachment_id

int

Optional

The unique id of the attachment to get

Get Ticket Counts

Get ticket counts.

POST https://your-domain-name/rapi/GetTicketCounts

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get Ticket Notes

Obtain a specific ticket notes.

POST https://your-domain-name/rapi/GetTicketNotes

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

ticket_id

int

Required

Obtain the ticket for the specific ticket id

Get Ticket Predefined Categories

Obtain the Predefined Ticket Reply Categories.

POST https://your-domain-name/rapi/GetTicketPredefinedCats

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get Ticket Predefined Replies

Obtain the Predefined Ticket Replies.

POST https://your-domain-name/rapi/GetTicketPredefinedReplies

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

category_id

int

Required

Obtain predefined replies for a specific category id

Get Tickets

Obtain tickets matching the passed criteria.

POST https://your-domain-name/rapi/GetTickets

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Required

The page number as 1

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The Records soring by order field name

sort_order

string

Optional

The Records soring by order ASC or DESC

department_id

int

Optional

Obtain tickets in a specific department

user_id

int

Optional

Find tickets for a specific client id

email

string

Optional

Find tickets for a specific non-client email address

status

string

Optional

Find tickets matching a specific status. Any configured status plus: Awaiting Reply, All Active Tickets, My Flagged Tickets

subject

string

Optional

Find tickets containing a specific subject - uses approximate string matching

Get To-Do Item Statuses

Obtain To Do item statuses and counts.

POST https://your-domain-name/rapi/GetToDoItemStatuses

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

Get To-Do Items

Get To-Do List Items.

POST https://your-domain-name/rapi/GetToDoItems

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Required

The page number as 1

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The Records soring by order field name

sort_order

string

Optional

The Records soring by order ASC or DESC

status

int

Optional

Status to filter for. Possible values include: 1 = New, 2 = In Process, 3 = Resolved, 4 = Duplicate, 5 = Postponed, 6 = Won't Fix

Get Transactions

Obtain transactions matching the passed criteria.

POST https://your-domain-name/rapi/GetTransactions

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

invoice_id

int

Optional

Obtain transactions for a specific invoice id

user_id

int

Optional

Find transactions for a specific client id

id

string

Optional

Find transactions for a specific transaction id

Get 2FA Modules

Obtain the Client 2FA Modules.

POST https://your-domain-name/rapi/GetTwoFaMods

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

2FA Modules for a specific client id

Get 2FA Verification Form

Get 2FA Verification Form for specific client.

POST https://your-domain-name/rapi/GetTwoFaVerificationForm

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

Client ID for verification of 2FA

Get User Permissions

Provide the permissions of a user for a client.

POST https://your-domain-name/rapi/GetUserPermissions

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The id of the client to retrieve the permissions for

Get Users

Obtain the Users that match passed criteria.

POST https://your-domain-name/rapi/GetUsers

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

page_num

int

Optional

The page number of records to return (default: 1)

limit_num

int

Optional

The number of records to return (default: 25)

sort_order_field

string

Optional

The direction to sort the results. ASC or DESC. Default: ASC

sort_order

string

Optional

The column to order by. id, first_name, last_name, company_name, email, groupid, datecreated, status

status

string

Optional

Optional desired User Status. Active, Inactive, or Closed

first_name

string

Optional

The search term to look for at the start of first_name

last_name

string

Optional

The search term to look for at the start of last_name

company_name

string

Optional

The search term to look for at the start of company_name

email

string

Optional

The search term to look for at the start of email

phonenumber

string

Optional

The search term to look for at the start of phonenumber

entry_date

string

Optional

The search term to look for at the start of creation date

Log Activity

Creates an activity log entry.

POST https://your-domain-name/rapi/LogActivity

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Optional

The ID of a client the log entry relates to.

description

string

Required

Description of the log activity

Merge Ticket

Merge tickets. Merges multiple tickets into a single ticket. This cannot be undone.

POST https://your-domain-name/rapi/MergeTicket

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

ticket_id

int

Required

The unique ticket id that mergeticket_ids will be merged into

merge_ticket_id

int

Required

The Ticket ID of ticket to merge into ticket_id

Module Change Package

Runs a change package action for a given service.

POST https://your-domain-name/rapi/ModuleChangePackage

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The service ID to run the action for

Module Change Password

Runs a change password action for a given service.

POST https://your-domain-name/rapi/ModuleChangePassword

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The service ID to run the action for

password

string

Optional

A new password to assign to the service

Module Create

Runs the module create action for a given service.

POST https://your-domain-name/rapi/ModuleCreate

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The service ID to run the action for

Module Custom

Runs a custom module action for a given service.

POST https://your-domain-name/rapi/ModuleCustom

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The service ID to run the action for

function_name

string

Required

The name of the custom function to run

function_json

string

Optional

The data in json format which need to perform various actions by your code, and in your module you can get values using custom > function_json variable

Module Suspend

Runs the module suspend action for a given service.

POST https://your-domain-name/rapi/ModuleSuspend

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The service ID to run the action for

reason

string

Optional

A reason for the suspension

Module Terminate

Runs a terminate action for a given service.

POST https://your-domain-name/rapi/ModuleTerminate

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The service ID to run the action for

Module Unsuspend

Runs an unsuspend action for a given service.

POST https://your-domain-name/rapi/ModuleUnsuspend

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The service ID to run the action for

reason

string

Optional

The unsuspension reason to run the action for

Order Fraud Check

Run a fraud check on a passed Order ID using the active fraud module.

POST https://your-domain-name/rapi/OrderFraudCheck

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

order_id

int

Required

The order id to complete the fraud check on

ip_address

string

Optional

To override the IP address on the fraud check

Pending Order

Sets an order, and all associated order items to Pending status.

POST https://your-domain-name/rapi/PendingOrder

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

order_id

int

Required

The order id to be accepted

Reset Password

Starts the password reset process for a user.

POST https://your-domain-name/rapi/ResetPassword

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Required

The id of the user/client to reset. The id can only belong to a user/client

Send Admin Email

Send an Admin Email Notification. If department_id empty then email sent to all admins instead of department assigned admins

POST https://your-domain-name/rapi/SendAdminEmail

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

subject

string

Optional

The subject to send for a custom email

message

string

Optional

The HTML message body to send for a custom email

department_id

int

Optional

The Id of the department the notification is for if support type

Send Email

Send a client Email Notification.

If type empty then default type is custom
If type eq to custom or empty then no need for template unique id
Incase of custom email subject, message, id required, id as client unique id for custom or general emails

POST https://your-domain-name/rapi/SendEmail

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

template

int

Optional

The unique email template id. If type in API request eq to custom then no need for template

id

int

Required

The related id for the type of email template. Eg this should be the client id for a general type email, client service_id for product type, cliet domain_id for domain type, client invoice_id for invoice type email

type

string

Optional

The type of custom email template to send (custom, general, product, domain, invoice)

subject

string

Optional

The subject to send for a custom email

message

string

Optional

The HTML message body to send for a custom email

Send Quote

Send a quote to the associated client.

POST https://your-domain-name/rapi/SendQuote

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

quote_id

int

Required

The id of the quote to send

Set Configuration Value

Set a System Configuration Value via the local API only.

POST https://your-domain-name/rapi/SetConfigurationValue

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

setting

string

Required

The setting name to change

value

string

Required

The value to set. Leave value blank to unset.

Remove Banned IP

Remove an IP from ban list.

POST https://your-domain-name/rapi/UnBanIp

Parameters

Field

Type

Optional

Description

token

text

Required

ip_address

string

Required

Update Admin Notes

Update the admin notes.

POST https://your-domain-name/rapi/UpdateAdminNotes

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

admin_id

int

Required

The admin_id is unique ID for the admin notes updation

notes

string

Required

The new value for the admin notes

Update Announcement

Update a specific announcement.

POST https://your-domain-name/rapi/UpdateAnnouncement

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

announcement_id

string

Required

The ID of the announcement to update.

title

string

Optional

The title of the announcement (if required to change).

announcement

string

Optional

The message of the announcement (if required to change).

entry_date

string

Optional

The date of the announcement (if required to change). Format: Y-m-d H:i:s

published

bool

Optional

Whether to publish the announcement (1 or 0) (if required to change).

Update Client

Updates a client with the passed parameters.

POST https://your-domain-name/rapi/UpdateClient

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

user_id

int

Optional

The ID of the client to update.

email

string

Optional

The email address of the client to update. Either $user_id or $user_email is required.

first_name

string

Optional

last_name

string

Optional

company_name

string

Optional

address1

string

Optional

address2

string

Optional

city

string

Optional

state

string

Optional

postcode

string

Optional

country

string

Optional

Two-character ISO country code.

phonenumber

string

Optional

tax_id

string

Optional

The client Tax ID.

currency

int

Optional

Currency ID from tblcurrencies.

group_id

int

Optional

Client Group ID from tblclientgroups.

custom_fields

string

Optional

Base64-encoded serialized array of custom field values.

language

string

Optional

Default language setting. Provide the full name: english, french, etc.

user_ip

string

Optional

IP address of the user.

notes

string

Optional

Admin-only notes.

status

string

Optional

The status. For example, Active.

payment_method_id

int

Optional

The default payment method.

general_emails

int

Optional

Whether the client should receive general emails.

product_emails

int

Optional

Whether the client should receive product emails.

domain_emails

int

Optional

Whether the client should receive domain emails.

affiliate_emails

int

Optional

Whether the client should receive affiliate emails.

invoice_emails

int

Optional

Whether the client should receive invoice emails.

support_emails

int

Optional

Whether the client should receive support emails.

Update Client Domain

Updates a Client Domain

POST https://your-domain-name/rapi/UpdateClientDomain

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

domain_id

int

Required

The ID of the client domain to update.

dnsmanagement

string

Optional

Whether to enable or disable DNS management.

emailforwarding

string

Optional

Whether to enable or disable Email forwarding.

idprotection

string

Optional

Whether to enable or disable ID protection.

donotrenew

string

Optional

Whether to prevent renewal.

registrationdate

string

Optional

The registration date of the domain. Format: Y-m-d

next_due_date

string

Optional

The next due date of the domain. Format: Y-m-d

expiry_date

string

Optional

The expiration date of the domain. Format: Y-m-d

domain

string

Optional

The domain name to be changed to.

firstpaymentamount

float

Optional

The first payment amount on the domain.

recurringamount

float

Optional

The recurring amount for automatic renewal invoices.

registrar

int

Optional

The registrar unique ID to associate with the domain.

registrationperiod

int

Optional

The registration period of the domain.

payment_method

int

Optional

The payment method unique ID to associate in system

status

string

Optional

The status to change the domain to. Status as mention (Pending, Pending Registration, Pending Transfer, Active, Grace, Redemption, Expired, Cancelled, Fraud, Transferred Away)

additionalnotes

string

Optional

The admin notes for the domain.

promo_id

int

Optional

The promotion ID to associate.

auto_recalculate_recurring_price

string

Optional

Whether to recalculate the recurring amount of the domain.

ns1

string

Optional

The first nameserver to save.

ns2

string

Optional

The second nameserver to save.

ns3

string

Optional

The third nameserver to save.

ns4

string

Optional

The fourth nameserver to save.

ns5

string

Optional

The fifth nameserver to save.

Update Client Note

Update a Client Note

POST https://your-domain-name/rapi/UpdateClientNote

Parameters

Field

Type

Optional

Description

token

text

Required

id

int

Required

The Client Note ID to apply the note to

user_id

int

Required

The Client ID to apply the note to

notes

string

Required

The note to add

sticky

bool

Optional

Should the note be made sticky. Makes the note sticky and displays the note throughout the clients account and on any tickets they submit in the admin area

Update Client Service

Updates a Client Service

POST https://your-domain-name/rapi/UpdateClientProduct

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

service_id

int

Required

The ID of the client service to update.

package

int

Optional

The package ID to associate with the service.

server

int

Optional

The server ID to associate with the service.

reg_date

string

Optional

The registration date of the service. Format: Y-m-d

next_due_date

string

Optional

The next due date of the service. Format: Y-m-d

termination_date

string

Optional

Update the termination date of the service. Format: Y-m-d

domain_name

string

Optional

The domain name to be changed to.

first_payment_amount

float

Optional

The first payment amount on the service.

amount

float

Optional

The recurring amount for automatic renewal invoices.

payment_method

string

Optional

The payment method to associate, in system format (for example, paypal).

billing_cycle

string

Optional

The term in which the product is billed on (for example, price_onetime_fee, price_monthly_fee, price_quarterly_fee, price_semi_annually_fee, price_annually_fee, price_biennially_fee, price_triennially_fee, price_four_years_fee, price_five_years_fee, price_six_years_fee, price_seven_years_fee, price_eight_years_fee, price_nine_years_fee, price_ten_years_fee).

status

string

Optional

The status to change the service to.

notes

string

Optional

The admin notes for the service.

user_name

string

Optional

The service username.

password

string

Optional

The service password.

override_auto_termination

int

Optional

Whether to provide override auto termination (on or off).

overide_auto_suspend

int

Optional

Whether to provide override auto suspend (on or off).

overide_suspend_until

string

Optional

Update the Override Suspend date of the service. Format: Y-m-d

ns1

string

Optional

(VPS/Dedicated servers only)

ns2

string

Optional

(VPS/Dedicated servers only)

dedicated_ip

string

Optional

assigned_ips

string

Optional

(VPS/Dedicated servers only)

disk_usage

int

Optional

The disk usage in megabytes.

disk_limit

int

Optional

The disk limit in megabytes.

bandwidth_usage

int

Optional

The bandwidth usage in megabytes.

bandwidth_limit

int

Optional

The bandwidth limit in megabytes.

suspend_reason

string

Optional

promo_id

int

Optional

The promotion ID to associate.

auto_recalculate_recurring_price

string

Optional

Whether to automatically recalculate the recurring amount of the service (Yes or No).

Update Invoice

Update an invoice using the provided parameters.

POST https://your-domain-name/rapi/UpdateInvoice

Parameters

Field

Type

Optional

Description

token

string

Required

Manage API Credentials

invoice_id

int

Required

The ID of the invoice to update.

status

string

Optional

The status of the invoice being updated.

payment_method_id

int

Optional

The payment method of the invoice in system format.

tax_amount

float

Optional

The first-level tax rate to apply to the invoice to override the system default.

entry_date

string

Optional

The date that the invoice should show as its creation date. Format: YYYY-mm-dd

due_date

string

Optional

The due date of the invoice. Format: YYYY-mm-dd

paid_date

string

Optional

The date paid for the invoice. Format: YYYY-mm-dd

notes

string

Optional

The notes to appear on the invoice.

Update Product

Update a product to the system to be available for purchase

POST https://your-domain-name/rapi/UpdateProduct

Parameters

Field

Type

Optional

Description

token

text

Required

id

int

Required

The unique ID of the product to be updated

title

string

Required

The name of the product to be updated

highlight_text

string

Optional

The highlight text of the product to display prominently on order forms in (Ribbens)

description

string

Optional

The description of the product, You may use HTML in this field for New lines, Bold, Bold Italics, Italic and other tags

notes

string

Optional

The product notes, You may use HTML in this field for New lines, Bold, Bold Italics, Italic and other tags

gid

int

Required

The id of the product group to add the product

slug

string

Optional

The friendly name of the product. Will be generated if not supplied.

tid

int

Required

Unique type id which mentioned in GetProductsTypes API Request

is_stock_control

string

Optional

Set to YES to enable stock control on the product, Default NO and options are YES or NO

unit_in_stock

int

Optional

How much of this product is in stock

payment_time

string

Optional

The payment type of the product. One of free, onetime, recurring, default value recurring is not entered in API request

price_duration

string

Required

The Default Price Duration for the product. One option should filled in API request from mentioned Options (price_monthly_fee, price_quarterly_fee, price_semi_annually_fee, price_annually_fee, price_biennially_fee, price_triennially_fee, price_four_years_fee, price_five_years_fee, price_six_years_fee, price_seven_years_fee, price_eight_years_fee, price_nine_years_fee, price_ten_years_fee)

cost

float

Required

The product cost price required based on selected default price duration for calcuations of Profit & Loss

setup_pricing

JSON

Required

JSON input required for product setup pricing based on base currency as

[{"price_monthly_fee":"0",  "price_quarterly_fee":"0",  "price_semi_annually_fee":"10",  "price_annually_fee":"20",  "price_biennially_fee":"40"}]

You can choose to include or omit the pricing key and its value.
Example:
If you don't want to apply a monthly price to this product, there's no need to include the price_monthly_fee key and its value, and vice versa.
Keys are mentioned in price_duration which required for pricing

old_pricing

JSON

Required

JSON input required for product old pricing based on base currency as

[{"price_monthly_fee":"0",  "price_quarterly_fee":"0",  "price_semi_annually_fee":"10",  "price_annually_fee":"20",  "price_biennially_fee":"40"}]

You can choose to include or omit the pricing key and its value.
Example:
If you don't want to apply a monthly price to this product, there's no need to include the price_monthly_fee key and its value, and vice versa.
Keys are mentioned in price_duration which required for pricing

sale_pricing

JSON

Required

JSON input required for product sale pricing based on base currency as

[{"price_monthly_fee":"0",  "price_quarterly_fee":"0",  "price_semi_annually_fee":"10",  "price_annually_fee":"20",  "price_biennially_fee":"40"}]

You can choose to include or omit the pricing key and its value.
Example:
If you don't want to apply a monthly price to this product, there's no need to include the price_monthly_fee key and its value, and vice versa.
Keys are mentioned in price_duration which required for pricing

is_hidden

string

Optional

Should the product be hidden from the client order form, Default NO and options are YES or NO

server_config_option_show

string

Optional

Only VPS/Dedicated Server Configuration options not visible to end users, Default NO and options are YES or NO

apply_tax

string

Optional

Does tax apply to the product, Default NO and options are YES or NO

recurring_cycles_limit

number

Optional

To limit this product to only recur a fixed number of times, enter the total number of times to invoice (0 = Unlimited)

auto_terminate_days

number

Optional

Enter the number of days after activation to automatically terminate (eg. free trials, time limited products, etc...)

auto_terminate_email

int

Optional

The id of the Email Template to use as the terminate email. Product/Service Messages only

eid_welcome

int

Optional

The id of the Email Template to use as the welcome email. Product/Service Messages only

prorata_billing_enable

string

Optional

Is pro-rata billing enabled for this product, Default NO and options are YES or NO

prorata_billing_day

int

Optional

Enter the day of the month you want to charge on

charge_next_month

int

Optional

Enter the day of the month after which the following month will also be included on the first invoice

product_setup_after

string

Optional

When should the product be automatically setup. One of PAYMENT_RECEIPT (on payment received), ORDER_PLACED (when order placed), ORDER_ACCEPTTED (when order accept manually), MANUALLY (Do not automatically setup this product)

server_type

string

Required

The server module system name to associate with the product. eg: cpanel, autorelease, plesk

server_group_id

int

Optional

The server group id used on product creation to associate an appropriate server

server_package_name

string

Optional

The package name from the server which id metioned in request, incase of server not required for the product then no need for the value of server_package_name

orderby

int

Optional

The order to in which to display on the order form

subdomain_options

string

Optional

Enter in the format example.com, abc.com (comma seperated list supported for multiple options) to offer on the domain register page.

domain_registration_option

string

Optional

Should the product show the domain registration options, Default NO and options are YES or NO

free_domain

string

Optional

Offer a free domain registration or renewal, Default NONE and options are NONE, FREE_WO_RENEWAL or FREE_W_RENEWAL

NONE = No Free Registration/Renewal and Transfer
FREE_WO_RENEWAL = Offer a free domain registration/transfer only (renew as normal)
FREE_W_RENEWAL = Offer a free domain registration/transfer and free renewal (if product is renewed)

free_domain_period

string

Optional

Free Domain Payment Terms, Comma Separated terms allowerd as (Free, price_onetime_fee, price_monthly_fee, price_quarterly_fee, price_semi_annually_fee, price_four_years_fee, price_five_years_fee, price_six_years_fee, price_seven_years_fee, price_eight_years_fee, price_nine_years_fee, price_ten_years_fee)

Free = Free Account
price_onetime_fee = One Time
price_monthly_fee = Monthly
price_quarterly_fee = Quarterly
price_semi_annually_fee = Semi-Annually
price_four_years_fee = 4-Year
price_five_years_fee = 5-Year
price_six_years_fee = 6-Year
price_seven_years_fee = 7-Year
price_eight_years_fee = 8-Year
price_nine_years_fee = 9-Year
price_ten_years_fee = 10-Year

free_domain_tlds

string

Optional

Comma Separated TLDs which allowed for free with this product as mentioned (com, pk, net, org) e.g

product_upgrade_plans

string

Optional

Comma Separated Products IDs which will be marked as upgrade, means user can place an upgrade order from small hosting or servers plan to large plan within same product groups

product_upgrade_email

int

Optional

Unique Email template ID for upgrade notification to customer on successful upgrade

product_upgrade_plans_enable

string

Optional

Enable to allow Upgrading/Downgrading of upgrade options, Default NO and options are YES or NO

products_config_groups

string

Optional

Comma Separated Configureable options groups IDs which will be display in cart for selection

custom_affiliate_payout

string

Optional

Enable Custom Affiliate Commission payout, Default (No Commission) and options are (Use Default, Percentage, Fixed Amount, No Commission)

is_affiliate_payout_type

string

Optional

Enable Affiliate Commission payout type, Default (One Time) and options are (One Time, Recurring)

affiliate_pay_amount

float

Optional

Affiliate Pay Amount in numeric values

is_overages_billing

string

Optional

Enable Overages usage Billing, Default (DISABLE) and options are (ENABLE, DISABLE)

disk_usage_limits

float

Optional

Disk Usage Soft limits in numeric values

disk_usage_limits_unit

string

Optional

Select Disk Overages usage Billing Size unit, Default (MB) and options are (MB, GB, TB)

disk_usage_limits_cost

float

Optional

Disk Usage Cost as per Usage Size per Unit based on base currency

bandwidth_usage_limits

float

Optional

Bandwidth Usage Soft limits in numeric values

bandwidth_usage_limits_unit

string

Optional

Select Bandwidth Overages usage Billing Size unit, Default (MB) and options are (MB, GB, TB)

bandwidth_usage_limits_cost

float

Optional

Bandwidth Usage Cost as per Usage Size per Unit based on base currency

configurations

JSON

Optional

Custom Configurations in JSON format and it will available in product details and at the time of provisioning modules execution

Update Product Group

Update a product group to the system

POST https://your-domain-name/rapi/UpdateProductGroup

Parameters

Field

Type

Optional

Description

token

text

Required

title

string

Required

The title of the group to be updated

gid

int

Required

The unique ID of the group to be updated

headline

string

Required

The head line of the group (Select Your Perfect Plan) eg.

tagline

string

Required

The Tag line of the group (With our 30 Day Money Back Guarantee You Can't Go Wrong!) eg.

suggestion

string

Optional

Yes to Offer services against domains at cart page and NO for Not Display.

default_group

string

Optional

Yes to mark this group as default products group for cart/order page in clientarea.

link

string

Optional

Product Group Custom Link for Services/Products Displayed, You can any link of 3rd party or your site page link

hidden

string

Optional

Group Hidden means, Hidden group or its products/services will not display to clients, YES eq to Hidden, NO eq to Not hidden

order_template

string

Optional

Order Template required to display products/serives in store page as per selection.

Update a TLD Extension

Update a TLD Extension. If a TLD exists, the existing record will be updated.
Prices should based on Base Currency because other currencies prices will be updated automatically.

POST https://your-domain-name/rapi/UpdateTLD

Parameters

Field

Type

Optional

Description

token

text

Required

TLD

string

Required

The extension to add (e.g., .com, .net, etc.)

IDP

string

Optional

Offer ID Protection for the extension

DNS

string

Optional

Offer DNS Management for the extension

EF

string

Optional

Offer Email Forwarding for the extension

EPP

string

Optional

Is an EPP required for domain transfers

SUG

string

Optional

Enable for Auto Suggestions

SPOT

string

Optional

If enabled as Spotlight then TLD will be showing at Domain Registration page as prominent.

SWSE

string

Optional

If enabled then Who's verification button will be showing to clients and clients can send whoi's verification email

REG

string

Required

The active registrar for automatic registration as (onlinenic, cosmos, connectreseller)

default_registration_period_price_off_from_cart

string

Required

if Domain TLD Free with any Service based on terms which is selected in Service/Product Configuration and Client Selected Different Registration Period of Domain then Price will be Off

voucher_required

string

Required

Vouchers/Prepaid Cards Required means, specific tld will be register/renew using voucher/prepaid card if added in whasols.

default_registration_period

string

Required

The Default registration period for TLD

FET

string

Optional

Specify a group label ('Free', 'HOT', 'NEW', 'SALE')

featured_color

string

Optional

TLD Featured will be showing at client side with selected color instead of None.

grace_days

int

Optional

The number of days for the grace period

grace_cost

float

Optional

The grace period fee cost for the extension

grace_fee

float

Optional

The grace period fee selling price for the extension

redemption_days

int

Optional

The number of days for the redemption period

redemption_cost

float

Optional

The redemption period cost for the extension

redemption_fee

float

Optional

The redemption period sellect price for the extension

cost

float

Required

TLD Cost, Based on Default Registration Period

register

string

Required

Comma Separated registration pricing as 10, 20, 30 so and so. (Maximum 10 values allowed), System will consider 1st value for 1 year, 2nd for 2 years and so and so.

renew

string

Required

Comma Separated renewal pricing as 10, 20, 30 so and so. (Maximum 10 values allowed), System will consider 1st value for 1 year, 2nd for 2 years and so and so.

transfer

string

Required

Comma Separated transfer pricing as 10, 20, 30 so and so. (Maximum 10 values allowed), System will consider 1st value for 1 year, 2nd for 2 years and so and so.

orderby

int

Optional

Modify TLD display order to follow another TLD

Update User

Update a user.

POST https://your-domain-name/rapi/UpdateUser

Parameters

Field

Type

Optional

Description

token

text

Required

Manage API Credentials

user_id

int

Required

The ID of the user to update.

first_name

string

Optional

last_name

string

Optional

email

string

Optional

language

string

Optional

Default language setting. Provide full name: english, french, etc

Upgrade Product

Upgrade, or calculate an upgrade on, a product

POST https://your-domain-name/rapi/UpgradeProduct

Parameters

Field

Type

Optional

Description

token

text

Required

Manage API Credentials

service_id

int

Required

The ID of the service to update

type

string

Optional

Only calculate the upgrade amount or Place an upgrade order Default: CALCULATE

new_item_id

int

Required

The ID of the new product

promo_code

string

Optional

The promotion code to apply to the upgrade

Validate Api

This command can be used to validate api using api token.

POST https://your-domain-name/rapi/ValidateApi

Parameters

Field

Type

Optional

Description

token

text

Required

Manage API Credentials

Validate Login

This command can be used to validate an email address and password against a registered user in WHASOLS.

POST https://your-domain-name/rapi/ValidateLogin

Parameters

Field

Type

Optional

Description

token

text

Required

Manage API Credentials

email

string

Required

User Email Address

password

string

Required

Password to validate

API References

Accept Order

Parameters

Accept Quote

Parameters

Add Announcement

Parameters

Add Banned IP

Parameters

Add Cancellation Request

Parameters

Add Client

Parameters

Add Client Note

Parameters

Add Contact

Parameters

Add credit to a given client.

Parameters

Add Funds invoice

Parameters

Add payment to a given invoice.

Parameters

Add an order to a client.

Parameters

Client Add Payment Method Form

Parameters

Add Product

Parameters

Add Product Group

Parameters

Add Refund

Parameters

Add Security Question

Parameters

Add Ticket Note

Parameters

Add Ticket Reply

Parameters

Add User

Parameters

Affiliate Activate

Parameters

Apply Credit

Parameters

Apply Promo Code

Parameters

Block Ticket Sender

Parameters

Payment gateway callback response

Parameters

Cancel Order

Parameters

Capture Payment

Parameters

Capture Payment by Invoice

Parameters

Register Domain add to cart

Parameters

Own Domain add to cart

Parameters

Renew Domain add to cart

Parameters

Transfer Domain add to cart

Parameters

Cart Add Item

Parameters

Change Billing duration

Parameters

Delete Cart Item

Parameters

Update Addon options

Parameters

Update Configs options

Parameters

Update Domain Configs

Parameters

Update Server Configs

Parameters

Verify Own Domain add to cart