Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyTypeRequiredDefaultDescription
rolelocalMembershipIdStringY One of 'member', 'trainer', 'salesperson'.
fullAccountBooleanYfalse

Club OS has 2 types of member accounts, Full and Basic. Full means they get access to both nutrition and/or workout features based on the club's service plan.

false - Make the member a Basic account.

true - Make the member full account.

trainerIdIntegerN The Club OS Your systems unique id for the trainer of the user being added or updatedmembership.
salespersonIdstatusIntegerBooleanNY The Club OS unique id for the salesperson of the user being added or updated (applies to members only).
templateUsernameStringN The username of the template account that should be applied to the user (applies to members only).
localUserIdStringY Your systems unique id for the user.
firstNameStringY User first name.
lastNameStringN User last name.
emailStringY Email address of the user.
genderStringY 'M' for male, 'F' for female.
birthdate

true - the membership is active and the customer is caught up on payments.

false - the membership is inactive due to deliquent billing, membership cancellation, etc.

autoRenewBooleanY 

true - membership auto-renews.

false - membership does not auto-renew.

startDateDate (M-d-YYYY)Y The effective start date of the membership.
endDateDate (M-d-YYYY)N User The end date of birththe membership if one exists.
joinDatesaleDateDate (M-d-YYYY)NY The date of the User joined the clubsale.
homePhonenameStringNY User home phone number.workPhoneThe name of the membership, i.e. 'Gold', 'Silver', 'Platinum'
downPaymentNameStringN User work phone number.mobilePhoneStringThe name of the down payment, i.e. 'Initiation Fee', or 'First Month Fee'
downPaymentSubtotalDecimalN User mobile phone numberThe amount of the down payment without taxes.
address1downPaymentTaxesStringDecimalN User address line 1

The amount of taxes on the down payment.

address2recurPaymentNameStringN User address line 2.
cityStringN User full city.
stateStringThe name of the recurring payment, i.e. 'Membership Dues'.
recurPaymentSubtotalDecimalN User 2 letter state code, i.e. PA for Pennsylvania.zipStringThe amount of the recurring payment without taxes.
recurPaymentTaxesDecimalN User zip codeThe amount of taxes on the recurring payment.

PUT /users

Update a users account type

...