Refresh

This website manage.optidigital.ca/kb/answer/1775 is currently offline. Cloudflare's Always Online™ shows a snapshot of this web page from the Internet Archive's Wayback Machine. To check for the live version, click Refresh.

Add Email Accounts

Description

Adds Email Accounts to an existing Enterprise Email Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id for which Email Accounts need to be added.
no-of-accounts Integer Required The number of Email Accounts to be added.
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
discount-amount Float Optional Discount amount for the order value.

HTTP Method

POST

Example Test URL Request

US Server https://test.httpapi.com/api/enterpriseemail/us/add-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=10&invoice-option=NoInvoice&discount-amount=0.00

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Enterprise Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Email Accounts Addition Action (actiontypedesc)

  • Action Id of the Email Accounts Addition Action (eaqid)

  • Email Accounts Addition Action Status (actionstatus)

  • Description of the Email Accounts Addition Action Status (actionstatusdesc)

  • Invoice Id of the Domain Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer Id associated with the Domain Name Order (customerid)

  • Discount Amount (discount-amount)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.