← Back to API List

home - adduser

Allows adding a user to an account

API Call Information

area: home

action: adduser

API Arguments

Argument	Data Type	Required	Description
username	string	Yes	username of the new user
password	string	Yes	password of the new user
firstname	string	Yes	firstname of the user
lastname	string	Yes	lastname of the user
address	string	Yes	address of the user
city	string	Yes	city of the user
region	string	Yes	state/region of the user
zip	string	Yes	zipcode/postal code of the user
country	string	Yes	two digit country code of the user
phone	string	Yes	phone number of the user

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=home&action=adduser&username=test&password=mypassword&firstname=john&lastname=smith&address=123 Main Street&city=Chicago&region=illinois&zip=60149&country=US

API Response

XML Response

<response>
<success>User Added</success>
<userid>1</userid>
</response>

JSON Response

{
    "success": "User Added",
    "userid": "1"
}