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
  • Required Arguments
  • Available fields
  • Examples
  1. API Reference
  2. Wellness Plans

Create a Supplement Plan for Member

Use the createSupplementPlan mutation to create and assign a supplement plan to a member.

Required Arguments

Argument

Type

Description

memberId

ID!

Id of user.

name

String!

Name of supplement plan.

startDate

Date!

Supplement plan starting date.

overview

String

Overview description of supplement plan.

nutrition

String

Text area to describe nutrition related to supplement plan.

exercise

String

Text area to describe exercise related to supplement plan.

resources

String

Text area to describe resources related to supplement plan.

visibility

Boolean

True will make the plan visible to the user, otherwise False

isActive

Boolean

True will make the plan active, otherwise False.

supplements

[SingleSupplement]

Array of supplements.

supplements.supplementId

ID!

Id of supplement.

supplements.directionsOfUSe

[DirectionsOfUseInput!]

supplements.directionsOfUse.quantity

Float!

Quantity of the supplement selected.

supplements.directionsOfUse.timeOfDay

TimeOfDay!

Time of day the member will take the supplement. Enum: AT_WAKING, WITH_BREAKFAST, WITH_LUNCH, WITH_DINNER, AT_BEDTIME.

supplements.length

Int!

Number of days the supplement needs to be taken.

supplements.monday

Boolean

True if the supplement should be taken on monday, otherwise False.

supplements.tuesday

Boolean

True if the supplement should be taken on tuesday, otherwise False.

supplements.wednesday

Boolean

True if the supplement should be taken on wednesday, otherwise False.

supplements.thursday

Boolean

True if the supplement should be taken on thursday, otherwise False.

supplements.friday

Boolean

True if the supplement should be taken on friday, otherwise False.

supplements.saturday

Boolean

True if the supplement should be taken on saturday, otherwise False.

supplements.sunday

Boolean

True if the supplement should be taken on sunday, otherwise False.

protocols

[SPProtocolInput]

protocols.protocolId

ID!

Id of protocol.

protocols.directionsOfUse

DirectionsOfUseInput!

protocols.directionsOfUse.quantity

Float!

Quantity of the protocol selected.

protocols.directionsOfUse.timeOfDay

TimeOfDay!

Time of day the member will take the supplements. Enum: AT_WAKING, WITH_BREAKFAST, WITH_LUNCH, WITH_DINNER, AT_BEDTIME.

protocols.monday

Boolean

True if the protocol should be taken on monday, otherwise False.

protocols.tuesday

Boolean

True if the protocol should be taken on tuesday, otherwise False.

protocols.wednesday

Boolean

True if the protocol should be taken on wednesday, otherwise False.

protocols.thursday

Boolean

True if the protocol should be taken on thursday, otherwise False.

protocols.friday

Boolean

True if the protocol should be taken on friday, otherwise False.

protocols.saturday

Boolean

True if the protocol should be taken on saturday, otherwise False.

protocols.sunday

Boolean

True if the protocol should be taken on sunday, otherwise False.

Available fields

Field

Type

Description

success

Boolean

True if the supplement plan has been created, Otherwise False.

message

String

Description of the result.

Examples

Example with Supplements only

mutation {createSupplementPlan(
  memberId:"TWVtYmVyOmVhYzk4MjU2LTQ0MWMtNGExNy04NmY4LWQwZDM3NzI5ZDU3ZQ=="
  input:{
    name:"Supplement plan only supplements example"
    isActive: true
    visibility: true
    startDate:"2023-09-01"
    supplements:[{
      supplementId:"U3VwgGxlbWVudDo5ZjdjZmU2YS04NzI0LTQ5OGUtYTc4ZC0zNDJhYjU3YmI5MDU="
      directionsOfUse:[{
        quantity:1
        timeOfDay: AT_WAKING
      },
      {
       quantity:2
       timeOfDay:WITH_DINNER 
      },
      ]
      length:20
      monday:true
      tuesday:true
      wednesday:true
      thursday:true
      friday:true
      saturday:true
      sunday:true
    },
    {
      supplementId:"U3VwcGxlbWVudDpjoDBmOTBhZS1kMmM3LTRhNDYtOWU0OC00NjIyOTNkNjBjMDc="
      directionsOfUse:[{
        quantity:2
        timeOfDay: AT_WAKING
      }]
      length:20
      monday:true
      tuesday:false
      wednesday:true
      thursday:false
      friday:true
      saturday:false
      sunday:false
    }]
  }
){
  success
  message
  }
}
{
  "data": {
    "createSupplementPlan": {
      "success": true,
      "message": "Supplement plan created"
    }
  }
}

Example with Protocols only

mutation {createSupplementPlan(
  memberId:"TWVtYmVyOmVhYzk4MjU2LTQ0MWMtNGExNy04NmY4LWQwZDM3NzI5ZDU3ZQ=="
  input:{
    name:"Supplement plan protocols only example"
    isActive: true
    visibility: true
    startDate:"2023-09-01"
    protocols:[{
      protocolId:"UHJvdG9jb2w6Njc2"
      directionsOfUse:[{
        quantity:1
        timeOfDay:AT_BEDTIME
      },
      {
        quantity:1
        timeOfDay:AT_WAKING
      }]
      monday: true
      tuesday: true
      wednesday: true
      thursday:true
      friday: true
      saturday: true
      sunday: true
    
    }]
  }
){
	success
  message
  }
}
{
  "data": {
    "createSupplementPlan": {
      "success": true,
      "message": "Supplement plan created"
    }
  }
}

Example with Protocols and Supplements

mutation {createSupplementPlan(
  memberId:"TWVtYmVyOmVhYzk4MjU2LTQ0MWMtNGExNy04NmY4LWQwZDM3NzI5ZDU3ZQ=="
  input:{
    name:"Supplement plan supplements & protocols example"
    isActive: true
    visibility: true
    startDate:"2023-09-01"
    supplements:[{
      supplementId:"U3VwcGxlbWVudDo5ZjdjZmU2YS04NzI0LTQ5OGUtYTc4ZC0zNDJhYjU3YmI5MDU="
      directionsOfUse:[{
        quantity:1
        timeOfDay: AT_WAKING
      },
      {
       quantity:2
       timeOfDay:WITH_DINNER 
      },
      ]
      length:20
      monday:true
      tuesday:true
      wednesday:true
      thursday:true
      friday:true
      saturday:true
      sunday:true
    },
    {
      supplementId:"U3VwcGxlbWVudDpjODBmOTBhZS1kMmM3LTRhNDYtOWU0OC00NjIyOTNkNjBjMDc="
      directionsOfUse:[{
        quantity:2
        timeOfDay: AT_WAKING
      }]
      length:20
      monday:true
      tuesday:false
      wednesday:true
      thursday:false
      friday:true
      saturday:false
      sunday:false
    }]
    protocols:[{
      protocolId:"UHJvdG9jb2w6Njc2"
      directionsOfUse:[{
        quantity:1
        timeOfDay:AT_BEDTIME
      },
      {
        quantity:1
        timeOfDay:AT_WAKING
      }]
    	monday: true
    	tuesday: true
    	wednesday: true
      thursday:true
      friday: true
      saturday: true
      sunday: true
    
    }]
  }
){
	success
  message
  }
}
{
  "data": {
    "createSupplementPlan": {
      "success": true,
      "message": "Supplement plan created"
    }
  }
}
PreviousWellness PlansNextUpdate Member Supplement

Last updated 1 year ago