TeleWellness Portal
  • Introduction
  • HELPFUL RESOURCES
    • Getting Started
    • FAQ
      • Appointments
      • Meal Plan
  • User Management
    • Roles and Permissions
    • Manage Coaches
      • Coach tab
        • Register a new coach
          • Assign Members
        • Edit an existing coach
      • Calendar tab
        • Appointment Types
        • Appointment Alerts
      • Note Templates tab
    • Manage Members
      • Create a new member
      • Edit member's information
      • Filter members
  • Using the TeleWellness Portal
    • Login and logout to the Portal
    • Navigating the TeleWellness Portal
      • Home
      • Dashboard
      • Admin Dashboard
      • Coach Dashboard
        • Progress Tab
          • Filtering the information
          • Checking the user’s streak progress
          • Checking the user's activities progress
          • Showing the food log history
          • Checking the user's recap questions
          • Checking the user's weight log history
          • Showing user’s program journey
          • Checking user’s water intake history
        • Meal Plan tab
        • Notes tab
        • Appointments tab
        • Lab Tests tab
        • Wellness Plans tab
      • Messages
      • Meal Plans
        • Manage Meal Plans
          • From Scratch
          • Smart Meal Plan
      • Scheduling
      • Wellness Plan
        • Manage Protocols
        • Manage Wellness Plan Templates
    • Note Templates
  • API Reference
    • Generate Authorization Token
    • Appointments
      • Appointment Types
      • Add Appointment Credits
    • Coaches
      • Coach List
      • Update a Coach
      • Create a Coach
      • Invite Coach
    • Members
      • Member List
      • Members List
      • Program List
      • Update member's program
      • Assign Coach to Member
    • Lab Test Reports
      • Lab Test Report List
      • Create a Lab Test Report
      • Update Lab Test Report
      • Delete a Lab Test Report
    • Wellness Plans
      • Create a Supplement Plan for Member
      • Update Member Supplement
      • List Member Supplement Plans
      • Delete Member Supplement Plan
Powered by GitBook
On this page
  • Input Fields
  • Available Fields
  1. API Reference
  2. Coaches

Invite Coach

PreviousCreate a CoachNextMembers

Last updated 2 years ago

Use the inviteCoach to send a user invitation access to the coaching portal.

This endpoint should be run on the ""

Input Fields

Field Name

Type

Description

email

String

user email

name

String

user name

disabled

Boolean

True if you want to disable user, otherwie False

makeAdmin

Boolean

True to make coach admin, otherwise False

allowSeeAll

Boolean

True to allow coach to see all members, otherwise False

members

Array

Assign users to coach

Available Fields

The following fields will be displayed in the response:

Field Name

Type

Description

success

Boolean

True if the coach has been invited successfully. Otherwise, False

message

String

Description of the result

coach

Object

Coach object details

mutation {
    inviteCoach(
        email: "randomuser@gmail.com"
        name: "Random User"
        disabled: False
        makeAdmin: False
        allowSeeAll: true
        members: ["ID"]
    ) {
        success message coach
    }
}
{
  "data": {
    "inviteCoach": {
      "success": true,
      "message": "Invitation sent",
      "coach": {
        "id": "Q29hY2g6ODk2",
        "email": "randomuser@gmail.com",
        "name": "Random User",
        "isAdmin": true,
        "isDisabled": false,
        "createdAt": "2021-11-24T18:07:29.189670+00:00",
        "updatedAt": "2022-01-17T21:27:54.241497+00:00"
      }
    }
  }
}p
Coaching Portal