API Service Documentation

Command: create_customer

Creates a new customer

Request

NameTypeRequiredExample
usernameStringYjohndoe

The username of the customer (alphanumeric and dashes). This cannot be left blank.

first_nameStringYJohn
last_nameStringYDoe
phoneStringY8005551234
emailStringYjohn.doe@example.com
companyStringNDoe Enterprises
passwordStringNPass123

If provided, the password must contain at least 7 characters and include at least one uppercase letter, one lower case letter, and one number

account_typeStringNCustomer

An optional/custom account type. If "Customer" (the default), this can be omitted.

external_idStringNabc123

An externally tracked ID used outside of this system.

enrollerIntegerN123

The internal user ID of the enroller/referrer, if any

external_enroller_idStringNabc123

The externally tracked ID of the enroller/referrer, if any
If enroller is provided, this field will be ignored

uplineIntegerN123

The internal user ID of the genealogy upline, if any

external_upline_idStringNabc123

The externally tracked ID of the genealogy upline, if any
If upline is provided, this field will be ignored

payout_methodStringNgeneral_csv

One of:

date_addedDate StringN2014-01-01 13:59:00

YYYY-MM-DD HH:MM:SS
A custom date of creation
(If omitted, assumes the current server date and time)

owneridIntegerN123

When present, creates a lead into the CRM of "ownerid"

gov_id_typestringNssn

Name of the government id type such as SSN or TAX ID. Requires gov_id_number value.

gov_id_numberIntegerN123456789

The government id number. Requires gov_id_type value.

Response

NameTypeExample
user_idInteger1001

The new internal ID used by this system