Users

Users are all of the individuals who use Boathouse Connect such as rowers, coaches, parents, boardmembers, etc. In this section, we are able to gather information about specific users, update data, find permissions of users, etc. Each user is assigned a custid when they first create an account on Boathouse Connect.

Add Additional Contact

Additional contacts are a way for the user to receive emails and text message to more than one email/phone. Generally used by high school athletes to add their parents contact info to the account but it can also be used for the user to receive communications in more than one place.

Parameters
token API Token.
type `phone` or `email` - type of contact being added.
contact Phone number of email address being added.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Add Emergency Contact

Adds a new emergency contact to the authenticated user. Emergency contacts can only be added by the user of the new emergency contact, not by other users in the organization.

Parameters
token API Token.
fname First name of the emergency contact.
lname Last name of the emergency contact.
phone Phone number for the emergency contact.
relationship Relationship of the emergency contact to the user. Limited to 100 characters.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            {"Status":"Success","Message":"Emergency contact added"}
                        
                            []
Success Response Key

Add USRowing Number

Adds the athletes USRowing number to their account.

Parameters
token API Token.
custid Custid of the user being updated.
usrowing_id USRowing membership number for the athlete.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Delete Emergency Contact

Deletes an emergency contact. Users may only delete their own emergency contacts, not the emergency contacts of others. Returns all remaining emergency contacts.

Parameters
token API Token.
emergency_contact_id Id of the emergency contact to delete.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            [{"emergency_contact_id":24,"custid":564,"fname":"Savannah","lname":"Testerson","phone":"(303) 386-1153","relationship":"Girlfriend","created_at":1595213129,"last_updated":1595213129},{"emergency_contact_id":25,"custid":564,"fname":"John","lname":"Demoman","phone":"(407) 421-2263","relationship":"Father","created_at":1596168370,"last_updated":1596168370}]
                        
                            []
Success Response Key

User Details

Provides an array of all details for either the authenticated user OR the user provided (as long as they are affiliated with the same whitelabel as the authenticated user).

Parameters
token API Token.
whitelabel_id (optional) Whitelabel Id of the organization you are affiliated with.
custid (optional) Custid of the user you wish to get the details of. Defaults to the authenticated user.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            {"custid":"564","fname":"Michael","lname":"Testington","yearendAge":28,"birthYear":1994,"birthMonth":9,"birthDay":21,"phoneNumber":"8659865245","height":71,"weight":"230","createdAt":1595213089,"dietary_restrictions":"","allergies":"none","initialSignin":"no","email":"Michael@BoathouseConnect.com","additional_contacts":[{"custid":564,"type":"email","contact":"Michael+alt@boathouseconnect.com"},{"custid":564,"type":"phone","contact":"6359875642"}],"sex":"Male","darkMode":"false","affiliations":[{"custid":564,"whitelabel_id":128,"whitelabel_name":"Test Club","whitelabel_abbreviation":"TRC","created_at":1592065082,"last_accessed":1637243361,"skin":1,"skin_hex_code":"#00acc1","timezone":"America\/New_York","user_count":1,"whitelabel_settings":[{"whitelabel_id":128,"name":"stripe.connectedaccount.charges_enabled","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.details_submitted","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.payouts_enabled","value":"true","last_updated":1641946502}],"plans":{"whitelabel_id":128,"plan_id":3,"plan_name":"Professional","monthly_price":"20","next_payment":1767614400}}],"usrowing":{"custid":564,"usrowingID":1426980,"waiver_signed":"Yes","waiver_expires":1637539200,"membership_expires":1637539200,"membership_title":"Championship (26 and Under)","last_updated":1628985616},"profile_image":"DEV\/PROFILEPICTURES\/564\/c9231c6d75270b908a57bfcaee148c6f8046491.jpg","lineup_preferences":{"custid":564,"port":4,"starboard":2,"sculling":5,"coxwain":1,"last_updated":1630708925},"emergency_contacts":[{"emergency_contact_id":33,"custid":564,"fname":"John","lname":"Testerson","phone":"8964853285","relationship":"Father","created_at":1618581691,"last_updated":1618581691},{"emergency_contact_id":34,"custid":564,"fname":"Savannah","lname":"Testable","phone":"303-896-0000","relationship":"Fiancee","created_at":1618581710,"last_updated":1618581710}],"address":null,"payment_account":{"custid":564,"env":"PROD","stripe_customer_id":"cus_KwrpAno1Hi0rJQ","preferred_payment_method":"card_1KKwosINTixHFl36yn3huMOY","delinquent":"No"},"feature_flag":null,"privacy":{"email_tracking_suppressed":false},"message_preferences":[{"message_type_id":1,"custid":"564","send_message":1,"last_updated":1623334300,"description":"Monthly organization status digest email."},{"message_type_id":2,"custid":"564","send_message":0,"last_updated":1623334463,"description":"Unread notifications."},{"message_type_id":3,"custid":"564","send_message":1,"last_updated":0,"description":"Upcoming practice lineups email."},{"message_type_id":4,"custid":"564","send_message":1,"last_updated":0,"description":"Post-practice survey email."},{"message_type_id":5,"custid":"564","send_message":1,"last_updated":0,"description":"New Boathouse Connect feature alert email."},{"message_type_id":6,"custid":"564","send_message":1,"last_updated":1636658277,"description":"Upcoming charge notification."}]}
                        
                            []
Success Response Key

Get User Permissions

Permissions are assigned to groups and users can be members of multiple groups. The user will then inherit the permissions of all of the groups they are a member of. This endpoint provides all of the permissions the given user has for the given whitelabel.

Parameters
token API Token.
whitelabel_id Whitelabel Id of the organization.
custid (optional) Custid of the user you want to retrieve permissions for (defaults to the authenticated user).
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            [{"permission_id":1,"title":"Basic Access","descr":"Anything every member of Boathouse Connect will need to access such as password reset, contact information, my profile information, notification center, etc."},{"permission_id":3,"title":"Remove User from Organization","descr":"Allows a person to remove an existing user in the organization. Removing a user from the organization will cause data-loss for the removed user. Limit the number of users with this permission to Super Admins or to a membership committee. "},{"permission_id":7,"title":"Set Practice Lineups","descr":"Allowed to create\/publish lineups for practices."},{"permission_id":8,"title":"Manage Equipment","descr":"Allowed to update information related to equipment."}]
                        
                            []
Success Response Key

Get User Whitelabels

Provides a list of all of the whitelabels the user is currently affiliated with. If the response is an empty array and does not return an error, the user is not affiliated with any whitelabels.

Parameters
token API Token.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            [{"custid":564,"whitelabel_id":128,"whitelabel_name":"Test Rowing Club","whitelabel_abbreviation":"TRC","created_at":1592065082,"last_accessed":1637243361,"skin":2,"skin_hex_code":"#00acc1","timezone":"America\/New_York","user_count":1,"whitelabel_settings":[{"whitelabel_id":128,"name":"stripe.connectedaccount.charges_enabled","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.details_submitted","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.payouts_enabled","value":"true","last_updated":1641946502}],"plans":{"whitelabel_id":128,"plan_id":3,"plan_name":"Professional","monthly_price":"20","next_payment":1767614400}}]
                        
                            []
Success Response Key

Get Emergency Contacts

Returns all emergency contacts that the user has set. Users are required to have at least one emergency contact and are advised to have multiples.

Parameters
token API Token.
whitelabel_id (optional) Whitelabel Id of the organization.
custid (optional) Custid of the user to get emergency contacts of. Defaults to the authenticated user.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            [{"emergency_contact_id":24,"custid":564,"fname":"Savannah","lname":"Testerson","phone":"(303) 386-1153","relationship":"Girlfriend","created_at":1595213129,"last_updated":1595213129},{"emergency_contact_id":25,"custid":564,"fname":"John","lname":"Demoman","phone":"(407) 421-2263","relationship":"Father","created_at":1596168370,"last_updated":1596168370}]
                        
                            []
Success Response Key

Remove Additional Contact

Removes the additional contact from the user's account.

Parameters
token API Token.
type `phone` or `email` - type of contact being removed.
contact Phone number of email address being removed.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Release Initial Signin Lock

Removes UI flag that requires information on first sign-in to the application. These values should be updated at least once per year to ensure accuracy. Information required in this section includes the users skill level for rowing & coxing, as well as an emergency contact. These questions are asked when the user first signs into the application.

Skill levels for port/starboard/sculling/coxswain include:
1 => Never Tried it.
2 => Done it a few times.
3 => Somewhat decent.
4 => I do this well.
5 => I am a master.

Parameters
token API Token.
port Skill rating (between 1-5) for rowing Port side.
starboard Skill rating (between 1-5) for rowing Starboard side.
sculling Skill rating (between 1-5) for Sculling.
coxswain Skill rating (between 1-5) for being a Coxswain.
fname Emergency contact first name.
lname Emergency contact last name.
phone Emergency contact phone number
relationship Relationship of the user to their emergency contact.
height Height of the user (in inches)
weight Weight of the user (in pounds)
street Street address of the user.
city City the user resides in.
state State / region the user resides in.
zip Postal code of their address.
dietary (optional) Dietary restrictions of the user.
allergies (optional) Allergies of the user.
street_2 (optional) Second line of the street address of the user.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            {"Success":"Preferences added!"}
                        
                            []
Success Response Key

Set Dark Mode

Setting dark mode to true will set the UI for the user to be darker colors. Setting it to false will use lighter colors in the background and navigation bar. This setting is not whitelabel specific so the setting will be retained regardless of which whitelabel the user is working in. This endpoint returns the same data as /users/generalDetails

Parameters
token API Token.
dark `true` or `false` - Determines whether dark mode is turned on or off.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            {"custid":"564","fname":"Michael","lname":"Testington","yearendAge":28,"birthYear":1994,"birthMonth":9,"birthDay":21,"phoneNumber":"8659865245","height":71,"weight":"230","createdAt":1595213089,"dietary_restrictions":"","allergies":"none","initialSignin":"no","email":"Michael@BoathouseConnect.com","additional_contacts":[{"custid":564,"type":"email","contact":"Michael+alt@boathouseconnect.com"},{"custid":564,"type":"phone","contact":"6359875642"}],"sex":"Male","darkMode":"false","affiliations":[{"custid":564,"whitelabel_id":128,"whitelabel_name":"Test Club","whitelabel_abbreviation":"TRC","created_at":1592065082,"last_accessed":1637243361,"skin":1,"skin_hex_code":"#00acc1","timezone":"America\/New_York","user_count":1,"whitelabel_settings":[{"whitelabel_id":128,"name":"stripe.connectedaccount.charges_enabled","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.details_submitted","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.payouts_enabled","value":"true","last_updated":1641946502}],"plans":{"whitelabel_id":128,"plan_id":3,"plan_name":"Professional","monthly_price":"20","next_payment":1767614400}}],"usrowing":{"custid":564,"usrowingID":1426980,"waiver_signed":"Yes","waiver_expires":1637539200,"membership_expires":1637539200,"membership_title":"Championship (26 and Under)","last_updated":1628985616},"profile_image":"DEV\/PROFILEPICTURES\/564\/c9231c6d75270b908a57bfcaee148c6f8046491.jpg","lineup_preferences":{"custid":564,"port":4,"starboard":2,"sculling":5,"coxwain":1,"last_updated":1630708925},"emergency_contacts":[{"emergency_contact_id":33,"custid":564,"fname":"John","lname":"Testerson","phone":"8964853285","relationship":"Father","created_at":1618581691,"last_updated":1618581691},{"emergency_contact_id":34,"custid":564,"fname":"Savannah","lname":"Testable","phone":"303-896-0000","relationship":"Fiancee","created_at":1618581710,"last_updated":1618581710}],"address":null,"payment_account":{"custid":564,"env":"PROD","stripe_customer_id":"cus_KwrpAno1Hi0rJQ","preferred_payment_method":"card_1KKwosINTixHFl36yn3huMOY","delinquent":"No"},"feature_flag":null,"privacy":{"email_tracking_suppressed":false},"message_preferences":[{"message_type_id":1,"custid":"564","send_message":1,"last_updated":1623334300,"description":"Monthly organization status digest email."},{"message_type_id":2,"custid":"564","send_message":0,"last_updated":1623334463,"description":"Unread notifications."},{"message_type_id":3,"custid":"564","send_message":1,"last_updated":0,"description":"Upcoming practice lineups email."},{"message_type_id":4,"custid":"564","send_message":1,"last_updated":0,"description":"Post-practice survey email."},{"message_type_id":5,"custid":"564","send_message":1,"last_updated":0,"description":"New Boathouse Connect feature alert email."},{"message_type_id":6,"custid":"564","send_message":1,"last_updated":1636658277,"description":"Upcoming charge notification."}]}
                        
                            []
Success Response Key

Update General Details

Allows updating basic, non whitelabel specific, details about the user. This endpoint returns the same data as /users/generalDetails

Parameters
token API Token.
fname (optional) New first name of the user.
lname (optional) New last name of the user.
usrowingId (optional) USRowing membership number of the user.
phone (optional) New phone number for the user.
email (optional) New email address for the user (must not be in use by any other user).
street1 (optional) New street address for the user.
street2 (optional) New street address (second line) for the user.
city (optional) New address city for the user.
state (optional) New address state/region for the user.
zipcode (optional) New address postal code for the user.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            {"custid":"564","fname":"Michael","lname":"Testington","yearendAge":28,"birthYear":1994,"birthMonth":9,"birthDay":21,"phoneNumber":"8659865245","height":71,"weight":"230","createdAt":1595213089,"dietary_restrictions":"","allergies":"none","initialSignin":"no","email":"Michael@BoathouseConnect.com","additional_contacts":[{"custid":564,"type":"email","contact":"Michael+alt@boathouseconnect.com"},{"custid":564,"type":"phone","contact":"6359875642"}],"sex":"Male","darkMode":"false","affiliations":[{"custid":564,"whitelabel_id":128,"whitelabel_name":"Test Club","whitelabel_abbreviation":"TRC","created_at":1592065082,"last_accessed":1637243361,"skin":1,"skin_hex_code":"#00acc1","timezone":"America\/New_York","user_count":1,"whitelabel_settings":[{"whitelabel_id":128,"name":"stripe.connectedaccount.charges_enabled","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.details_submitted","value":"true","last_updated":1641946502},{"whitelabel_id":128,"name":"stripe.connectedaccount.payouts_enabled","value":"true","last_updated":1641946502}],"plans":{"whitelabel_id":128,"plan_id":3,"plan_name":"Professional","monthly_price":"20","next_payment":1767614400}}],"usrowing":{"custid":564,"usrowingID":1426980,"waiver_signed":"Yes","waiver_expires":1637539200,"membership_expires":1637539200,"membership_title":"Championship (26 and Under)","last_updated":1628985616},"profile_image":"DEV\/PROFILEPICTURES\/564\/c9231c6d75270b908a57bfcaee148c6f8046491.jpg","lineup_preferences":{"custid":564,"port":4,"starboard":2,"sculling":5,"coxwain":1,"last_updated":1630708925},"emergency_contacts":[{"emergency_contact_id":33,"custid":564,"fname":"John","lname":"Testerson","phone":"8964853285","relationship":"Father","created_at":1618581691,"last_updated":1618581691},{"emergency_contact_id":34,"custid":564,"fname":"Savannah","lname":"Testable","phone":"303-896-0000","relationship":"Fiancee","created_at":1618581710,"last_updated":1618581710}],"address":null,"payment_account":{"custid":564,"env":"PROD","stripe_customer_id":"cus_KwrpAno1Hi0rJQ","preferred_payment_method":"card_1KKwosINTixHFl36yn3huMOY","delinquent":"No"},"feature_flag":null,"privacy":{"email_tracking_suppressed":false},"message_preferences":[{"message_type_id":1,"custid":"564","send_message":1,"last_updated":1623334300,"description":"Monthly organization status digest email."},{"message_type_id":2,"custid":"564","send_message":0,"last_updated":1623334463,"description":"Unread notifications."},{"message_type_id":3,"custid":"564","send_message":1,"last_updated":0,"description":"Upcoming practice lineups email."},{"message_type_id":4,"custid":"564","send_message":1,"last_updated":0,"description":"Post-practice survey email."},{"message_type_id":5,"custid":"564","send_message":1,"last_updated":0,"description":"New Boathouse Connect feature alert email."},{"message_type_id":6,"custid":"564","send_message":1,"last_updated":1636658277,"description":"Upcoming charge notification."}]}
                        
                            []
Success Response Key

Update Health Details

Parameters
token API Token.
dietary Dietary restrictions of the user.
allergies Known allergies of the user.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Height and Weight

Parameters
token API Token.
height Height of the user (in inches).
weight Weight of the user (in pounds).
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Update Rowing Skills

Parameters
token API Token.
port Skill level of rowing sweep-port (1-5).
starboard Skill level of rowing sweep-starboard (1-5).
sculling Skill level of sculling (1-5).
coxwain Skill level of being a coxswain (1-5) - *note the misspelling of the parameter*.
custid (optional) Custid of the user being updated. Defaults to the authenticated user.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            []
                        
                            []
Success Response Key

Get All Join Requests

Provides a list of all of the whitelabels the user has requested to join. This endpoint can only be used by the authenticated user.

Parameters
token API Token.
Try It!
Required Permissions
No special permissions required to access this endpoint.

Sample Responses

                            [{"custid":564,"whitelabel_id":128,"whitelabel_name":"Test Rowing Club","status":"Pending","timestamp":1595860652},{"custid":564,"whitelabel_id":127,"whitelabel_name":"New Orleans Rowing Club, Ltd.","status":"Approved","timestamp":1595213089}]
                        
                            []
Success Response Key

Don't like coding?

Checkout our integration with Zapier! Zapier is a platform that allows you to connect Boathouse Connect to over 3,000+ other applications & services Go To Zapier




Overview

Actions

About Us

Copyright © 2011-2024 Merwin Software, LLC / Boathouse Connect