How to update user information

A user may be updated by using the update method

 

Method	URL
GET	https://api.fairwarningsoftware.com/v1.1.1/user/update

 

Below is a list of all fields which can be specified during an update.

 

Field	Type	Required	Description
user_id	int	YES	The user's unique identification number from the FWS management software.
type_id	int	NO	The ID associated with the customer type from the FWS management software.
user_verified	bool	NO	Whether the user's email address has been verified.
user_receive_texts	bool	NO	Whether the user agrees to receive texts.
user_is_preferred_bidder	bool	NO	Indicates whether this user is auto-approved to bid (when applicable).
user_is_firearms_dealer	bool	NO	Indicates whether this user is a licensed firearms dealer.
user_ffl_number	string	NO	Federal firearms license number.
user_class_3_ffl_number	string	NO	Class 3 federal firearms license number.
user_ffl_expiration_date	date	NO	Federal firearms license expiration date (YYYY-MM-DD).
user_class_3_ffl_expiration_date	date	NO	Class 3 federal firearms license expiration date (YYYY-MM-DD).
user_is_tax_exempt	bool	NO	Indicates whether the user is tax exempt.
user_tax_id	string	NO	The user's tax exempt tax ID.
user_tax_id_expiration_month	int	NO	The user's tax exempt expiration month.
user_tax_id_expiration_year	int	NO	The user's tax exempt expiration year.
user_tax_id_state	string	NO	The user's tax exempt state.
user_email	string	YES	The primary email address, which will also be used as the user's login.
user_alt_email	string	NO	An alternate email address fo rthe user.
user_pass	string	YES	The user's password, sha1 encoded.
user_prefix	string	NO	The user's name prefix.
user_fname	string	YES	The user's first name.
user_mname	string	NO	The user's middle name.
user_lname	string	YES	The user's last name.
user_phone	string	NO	The user's primary phone number (XXX-XXX-XXXX).
user_alt_phone	string	NO	The user's alternate, or secondary, phone number (XXX-XXX-XXXX).
user_cell_phone	string	NO	The user's cell phone for receiving texts.
user_fax	string	NO	The user's fax number (XXX-XXX-XXXX).
user_phone_country_code	string	NO	The country code for the user's phone number.
user_alt_phone_country_code	string	NO	The country code for the user's alt phone number.
user_cell_phone_country_code	string	NO	The country code for the user's cell phone number.
user_fax_country_code	string	NO	The country code for the user's fax number.

 

Additionally, address information can be sent with the user update request using the <addresses/> object (see JSON example), and can contain multiple addresses.

 

Field	Type	Required	Description
address_id	int	NO	The existing address ID if updating an address.  Leave blank to add a new address.
address_type	int	YES	The type of address: "1" for billing, "2" for shipping.
address_current	bool	NO	Whether this is the current address for the address type specified.  (Only one current address per type.)
address_street	string	YES	The house number and street name.
address_street2	string	NO	The unit/apartment number and prefix.  (Apt 3)
address_city	string	YES	The city
address_state	string	YES	The state abbreviation
address_zip	string	YES	The zip code
address_country	string	YES	The 2-digit country code.

 

Lastly, maillist preferences can be sent with the user registration request using the <maillists/> object (see JSON example), and can contain multiple mailing list options.

 

Field	Type	Required	Description
<list_safe_name>	string	YES	The safe name of the mail list being added

 

 

 

If successful, the response will contain the  user details, or else it will contain an error.