API Service Documentation

Command: update_user

Updates a user. All fields available in the `users` table are applicable as optional parameters.

Request

NameTypeRequiredExample
userIDIntegerY123

The userID of the row to update. Not required if username or external_id is provided

usernameStringYjohndoe

The unique username of the row to update. Not required if userID or external_id is provided

exteral_idStringYAbc123

The unique external_id of the row to update. Not required if userID or usernameis provided

passwordStringNPass123

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

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

An optional/custom account type

countryCharNUS

Resident country of the user.

is_businessBooleanNTrue

Any non-empty value besides is true, except: n, no, false

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.