Whitelabels
Whitelabels represent different organizations/clubs on Boathouse Connect. Users can become affiliated with one or more whitelabels.
Add Pre-authorization
POST whitelabel/addPreAuthorization
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| Email address of a potential user to pre-authorize. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 2 | Add User to Organization | Allows a person to authorize other Boathouse Connect users to join this organization. Also allows a person to pre-authorize users to join this organization. |
Sample Responses
[]
[]
Success Response Key
Request To Join Whitelabel
POST whitelabel/requestInvitation
In order for a user to become affiliated with a whitelabel, the user must either request an invitation to join, or already
be pre-authorized by the admins of the whitelabel. This endpoint is used to request an invitation to the whitelabel.
Parameters
| token | API Token. |
|---|---|
| requested_whitelabel | Whitelabel Id of the organization that you want to request membership to. |
| Email address of the user requesting to join. |
Required Permissions
No special permissions required to access this endpoint.Sample Responses
{"Status":"Success","Message":"Request sent.","NewState":"Pending"}
[]
Success Response Key
Approve Pending Join Requests
POST whitelabel/approveJoinRequest
Allows you to add a user to the whitelabel (organization) by approving their join request.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| custid | Custid of the user being approved to join. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 2 | Add User to Organization | Allows a person to authorize other Boathouse Connect users to join this organization. Also allows a person to pre-authorize users to join this organization. |
Sample Responses
{"Status":"Success","Message":"Added to whitelabel.","NewState":"Approved"}
[]
Success Response Key
Decline Pending Join Requests
POST whitelabel/declineJoinRequest
Declines a users join request. The user will not be able to join the whitelabel unless they resend a join request and
the new request is approved.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| custid | Custid of the user being declined. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 2 | Add User to Organization | Allows a person to authorize other Boathouse Connect users to join this organization. Also allows a person to pre-authorize users to join this organization. |
Sample Responses
{"Status":"Success","Message":"Join request declined.","NewState":"Declined"}
[]
Success Response Key
Get Declined Join Requests
GET whitelabel/getDeclinedJoinRequests
Gets all whitelabel join requests that have been declined.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"custid":566,"status":"Declined","timestamp":1595864752,"fname":"Myke","lname":"Testerson","whitelabel_id":128}]
[]
Success Response Key
Get Pending Join Requests
GET whitelabel/getPendingJoinRequests
Returns an array of all of the users that have requested an invitation to join the whitelabel.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"custid":347,"status":"Pending","timestamp":1595352827,"fname":"Lindsay","lname":"Demoson","whitelabel_id":95},{"custid":2243,"status":"Pending","timestamp":1595355482,"fname":"Savannah","lname":"Tempperson","whitelabel_id":95}]
[]
Success Response Key
Get All Pre-Authorized Emails
GET whitelabel/getPreauthorizedEmails
Retrieves all pending pre-authorizations for the whitelabel. Pre-authorizations allow a user to join the whitelabel without
having make a join request. As soon as a user with a pre-authorized email joins Boathouse Connect, they will automatically
be approved to join the whitelabel.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"id":4,"email":"stan@yahoo.com","whitelabel_id":95,"created_at":1595424497,"created_by":"Michael Demoman","custid_creator":564},{"id":14,"email":"emily@gmail.com","whitelabel_id":95,"created_at":1595948479,"created_by":"Michael Demoman","custid_creator":564}]
[]
Success Response Key
Remove Pre-Authorized Email
POST whitelabel/removepreauthorizedEmail
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| Email address of a potential user to remove from pre-authorized list. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 2 | Add User to Organization | Allows a person to authorize other Boathouse Connect users to join this organization. Also allows a person to pre-authorize users to join this organization. |
Sample Responses
[]
[]
Success Response Key
Remove User
POST whitelabel/removeUser
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| custid | Custid of the user to remove from the organization. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 3 | Remove User from Organization | 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. |
Sample Responses
[]
[]
Success Response Key
Get Boathouse Rewards
GET whitelabel/getRewards
Boathouse Rewards are a way to incentivize specific actions and behaviors on Boathouse Connect. This endpoint returns all
possible rewards, and rewards history for the whitelabel. This endpoint returns 6 different elements: 1) current point
balance, 2) next reward that can be redeemed, 3) all prizes and how many points they are worth, 4) what triggers earning
points, 5) all prizes/points that have been redeemed, and 6) point-earning history.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
{"balance":22,"next_reward":{"reward_prize_id":1,"points":250,"item":"10 cam-buckle boat straps (9ft or 12ft)","descr":"If your boats are stored outside, or your club travels frequently, new boat straps are always needed. For 250 points, your club will receive 10 new Boathouse Connect boat straps. We will reach out to get a proper mailing address as well as what size straps you want.","status":"Active","points_left":228},"prizes":[{"reward_prize_id":1,"points":250,"item":"10 cam-buckle boat straps (9ft or 12ft)","descr":"If your boats are stored outside, or your club travels frequently, new boat straps are always needed. For 250 points, your club will receive 10 new Boathouse Connect boat straps. We will reach out to get a proper mailing address as well as what size straps you want.","status":"Active"},{"reward_prize_id":2,"points":600,"item":"4-pack of 100 nuts & washers (400 nuts and 400 washers)","descr":"Boat hardware is always in short supply. Redeeming this reward for 600 points, you will get 200 10mm stainless-steel nuts & washers AND 200 7\/16\" stainless-steel nuts & washers. If all of your boats are the same size, you can request to receive 400 of one size instead of 200 each.","status":"Active"}],"triggers":[{"reward_trigger_id":1,"action":"Verify email address","descr":"When a new user account is created, earn points by verifying the email address.","points":1,"entity":"user","frequency":0,"status":"Active"},{"reward_trigger_id":2,"action":"Verify cell phone number","descr":"When a user adds a cell phone number and opts in to receive text message notifications.","points":1,"entity":"user","frequency":0,"status":"Active"},{"reward_trigger_id":3,"action":"Create first group","descr":"When an organization creates their first group and adds at least one member to the group. ","points":5,"entity":"whitelabel","frequency":0,"status":"Active"}],"redemptions":[],"history":[{"reward_hist_id":9,"whitelabel_id":127,"custid":564,"fname":"Michael","lname":"Testerson","trigger_id":10,"points_earned":5,"timestamp":1599107015,"action":"Add first set of oars","descr":"First time adding a set of oars to the organizations equipment inventory."},{"reward_hist_id":8,"whitelabel_id":127,"custid":564,"fname":"Michael","lname":"Testerson","trigger_id":9,"points_earned":5,"timestamp":1599106686,"action":"Add first boat","descr":"First time adding a boat to the organizations equipment inventory."}]}
[]
Success Response Key
Get Unaffiliated Whitelabels
GET whitelabel/getUnaffiliatedWhitelabels
Returns a list of whitelabels the user is not currently affiliated with. Helpful for displaying a list of organizations
that the user to a user when they need to join a whitelabel.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"whitelabel_id":127,"name":"New Orleans Rowing Club, Ltd.","rc_orgid":638,"created_at":1595213089,"custid_claimed":564,"abbreviation":"NORC","timezone":"America\/Chicago"},{"whitelabel_id":128,"name":"Boulder Community Rowing, Inc.","rc_orgid":1,"created_at":1595219634,"custid_claimed":623,"abbreviation":"BLDR","timezone":"America\/Denver"}]
[]
Success Response Key
Get All Whitelabel Users
GET whitelabel/getWhitelabelUsers
Returns an array of all of the users currently affiliated with the whitelabel.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[{"custid":564,"joined_whitelabel_on":1595213089,"fname":"Michael","lname":"Demoman","birthYear":1994,"birthMonth":8,"birthDay":9,"yearendAge":26,"sex":"Male","email":"Michael@example.net","phone_number":"4072226658","usrowingID":113284,"usrowing_waiver_expires_on":1595352827},{"custid":565,"joined_whitelabel_on":1595352827,"fname":"Lindsay","lname":"Madeupperson","birthYear":1996,"birthMonth":10,"birthDay":23,"yearendAge":24,"sex":"Female","email":"Lindsay@demotown.com","phone_number":"3033862855","usrowingID":null,"usrowing_waiver_expires_on":null}]
[]
Success Response Key
Require Join Approval
POST whitelabel/requireJoinApproval
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| require_join_approval | `No` or `Yes` - Whether or not users must be approved (or pre-authorized) to join the organization. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 17 | Manage Organization Settings | Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc. |
Sample Responses
[]
[]
Success Response Key
Update Last Time Accessed
POST whitelabel/updateTimeAccessed
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Update Timezone
POST whitelabel/updateTimezone
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| timezone | New timezone to set for the organization. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 17 | Manage Organization Settings | Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc. |
Sample Responses
[]
[]
Success Response Key
Get Whitelabel Calendar
GET whitelabel/getCalendar
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Get Calendar Events
GET whitelabel/getEvents
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Add Calendar Event
POST whitelabel/addCalendarEvent
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| title | Title of the event. |
| start_time | UNIX timestamp of the start of the event. |
| end_time | UNIX timestamp of the end of the event. |
| descr | Description of the event. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 17 | Manage Organization Settings | Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc. |
Sample Responses
[]
[]
Success Response Key
Remove Calendar Event
POST whitelabel/removeEvent
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| event_id | Id of the event to remove. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 17 | Manage Organization Settings | Allowed to change basic organization-related settings, such as uploading logos, setting timezone, etc. |
Sample Responses
[]
[]