Create or update a user
You can submit a POST to /v1/users to create a new user. The email, firstName, and lastName attributes are the minimum required fields within the request body.
If you POST to this endpoint and reference an email that already exists within your account, that existing user record will be updated. Only those parameters passed in the request will be updated. When performing an update, you can send the email address as part of the request body or as part of the request URL:
- POST /v1/users (include "email": "some.email@domain.com" in the body)
- POST /v1/users/some.email@domain.com
| Attributes |
|---|
email Required
string
Email address of the user being created or updated. Users are uniquely identified based on their email address.
|
firstName Conditionally Required
string
Required when creating a new user. The user's first name.
|
lastName Conditionally Required
string
Required when creating a new user. The user's last name.
|
active
boolean
Set the user as active or inactive. If not specified when creating a user, defaults to true.
|
memberNumber
string
Specify the associated Member Number, if applicable.
|
address
string
The user's street address.
|
city
string
The address city.
|
state
string
The address state (for US addresses only). This can be specified using either the two-digit state code (e.g., "GA") or the full state name (e.g., "Georgia").
|
provinceOrRegion
string
The province or other region associated with the address (for non-US addresses).
|
postalCode
string
The address postal code.
|
phone
string
The user's primary contact phone number.
|
emergencyContactName
string
Name of any associated emergency contact person.
|
emergencyContactPhone
string
Phone number for the emergency contact.
|
membershipPlan
string
Assign an existing membership plan to the user. Pass the full name of the plan (must match exactly, case insensitive).
|
membershipExpirationDate
string
Assign a Membership Expiration Date (must be formatted as YYYY-MM-DD).
|
signedWaiver
boolean
Set the "Signed Waiver?" flag for the user. Defaults to false if not passed.
|
paidDues
boolean
Set the "Paid Dues?" flag for the user. Defaults to false if not passed.
|
accountExpirationDate
string
Assign the "Account Expires" date for the user (must be formatted as YYYY-MM-DD). If this expiration date is set, the user cannot log in once it passes.
|