API Guide

Create Account Alias

This API allows you to create a new account alias. Successful alias creation will result in the API returning the ID of the new alias. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: POST

Endpoint URL:


Sample Output:



Parameter Description Acceptable Values Required
firstname The user's first name. String Y
lastname The user's last name. String Y
email The unique/valid email of the account alias. Valid email Y
password The password for the account. String Y
forcepasswordreset Force the user to reset their password on the first login. Boolean N
emailcredentials Email login credentials to the user being created. Boolean N

Error Responses

Description Code Cause
NULL 401 Your API key does not have sufficient permission to access this endpoint.
Error creating account alias 404 There was an unspecified error creating the alias.
Form Validation 404 We will return an array of errors if there are form validation issues, i.e. an invalid email address