...
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
| role | String | Y | One of 'member', 'trainer', 'salesperson', 'manager', or 'frontdesk'. | |
| fullAccount | Boolean | Y | false | 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 a Full account. |
| sendEmail | Boolean | Y | false | If true, sends a welcome email to the member if they are created successfully and an email address was sent. |
| trainerId | Integer | N | The Club OS unique id for the trainer of the user being added or updated. | |
| salespersonId | Integer | N | The Club OS unique id for the salesperson of the user being added or updated (applies to members only). | |
| templateUsername | String | N | The username of the template account that should be applied to the user (applies to members only). | |
| localUserId | String | Y | Your systems unique id for the user. | |
| firstName | String | Y | User first name. | |
| lastName | String | N | User last name. | |
| String | N | Email address of the user. This will also be the username for the Club OS account . If left blank, the user will not be able to login to Club OSif no username if provided. | ||
| username | String | N | Username of the user. This will be used to login to the system. | |
| password | String | N | Password for the account. If left blank, one will be auto-generated. Only applies if email exists and is valid. | |
| gender | String | Y | 'M' for male, 'F' for female. | |
| birthDate | Date (M-d-YYYY) | N | User date of birth. | |
| joinDate | Date (M-d-YYYY) | N | The date the User joined the club. | |
| guestPassStart | Date (M-d-YYYY) | N | The start date of the user's guest pass. | |
| guestPassEnd | Date (M-d-YYYY) | N | The end date of the users's guest pass. | |
| homePhone | String | N | User home phone number. | |
| workPhone | String | N | User work phone number. | |
| mobilePhone | String | N | User mobile phone number. | |
| address1 | String | N | User address line 1. | |
| address2 | String | N | User address line 2. | |
| city | String | N | User full city. | |
| state | String | N | User 2 letter state code, i.e. PA for Pennsylvania. | |
| zip | String | N | User zip code. |
...