Invite user - Veryfront

inviteUser(input: InviteUserInput!): InviteUserPayload

Requires project.invites.manage and available seats. type distinguishes the result; id is a user ID for USER_ADDED or invitation ID for INVITE_CREATED. emailSent reports the notification send result.

Arguments

Argument	Type	Required
`input`	`InviteUserInput!`	Yes

Input fields

input

InviteUserInput

Field	Type	Required
`email`	`String!`	Yes
`role`	`InvitableProjectRoleName!`	Yes

Response

Returns InviteUserPayload. Open the type for its fields and nested types.

Field	Type	Description
`id`	`ID!`	User ID for USER_ADDED; invitation ID for INVITE_CREATED.
`type`	`InviteUserResultType!`	Whether an existing user was added or a pending invitation was created.
`emailSent`	`Boolean!`	Whether the email service accepted the notification send. False when sending is unavailable or fails; this does not confirm inbox delivery.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation InviteUser($input: InviteUserInput!) {
  inviteUser(input: $input) {
    id
    emailSent
    type
  }
}

{
  "input": {
    "email": "example",
    "role": "admin"
  }
}