Skip to content
inviteGuardianMutation
inviteGuardian(family: EntityRef!, email: String!, role: FamilyRole!): FamilyInviteResult!

Invite another adult by email to join a family as a manager or guardian. The viewer must be a manager/guardian of the family. Emails the invitee a link that signs them in (creating an account if needed) and lands on the accept page. role must be manager or guardian — never child.

Arguments

familyEntityRef!
emailString!

Returns

FamilyInviteResult!

See FamilyInviteResult for the full shape.

Try it

Example
Query
mutation InviteGuardian($family: EntityRef!, $email: String!, $role: FamilyRole!) {
  inviteGuardian(family: $family, email: $email, role: $role) {
    __typename
  }
}
Variables
{}
POST https://go.sessions.website/api/graphql
inviteGuardian