API Guide

Update Account Alias

This API allows you to update the information for an existing account 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: PUT

Endpoint URL:


Sample Output:

    "status": "success"


Parameter Description Acceptable Values Required
id The unique identifier of the alias account. Required if external_is blank. Integer Y
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 N
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

Status Responses

Status Description
success 'status' => 'success' indicates that the update was successful.
error An 'error' string will return specific errors related to data validation or permissions.

Error Responses

Description Code Cause
NULL 401 Your API key does not have sufficient permission to access this endpoint
The alias does not exist. 404 The unique identifier of the account alias is invalid
You don't have access to this account alias. 403 The account alias is not owned by the account provided in the API key
Form Validation 404 We will return an array of errors if there are form validation issues, i.e. an invalid email address