Invite Coach

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

This endpoint should be run on the "Coaching Portal"

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
    }
}

Last updated