createProjectInvitation(projectReference: ID!, input: CreateProjectInvitationInput!): ProjectInvitationResult!

Requires project.invites.manage.

Arguments

Argument	Type	Required	Description
`projectReference`	`ID!`	Yes	Project UUID or slug.
`input`	`CreateProjectInvitationInput!`	Yes

Input fields

input

CreateProjectInvitationInput

Field	Type	Required	Description
`email`	`String!`	Yes	Email address to invite; stored in lowercase.
`role`	`ProjectInvitationRole!`	Yes

Response

Returns ProjectInvitationResult!. Open the type for its fields and nested types.

Field	Type	Description
`outcome`	`ProjectInvitationOutcome!`
`invitation`	`ProjectInvitation`	The pending invitation; null when outcome is member_added.
`userId`	`ID`	The added user; set only when outcome is member_added.
`emailSent`	`Boolean!`	Whether the email service accepted the notification send; false is a result, not an error.

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

Example

graphql

mutation CreateProjectInvitation($projectReference: ID!, $input: CreateProjectInvitationInput!) {
  createProjectInvitation(projectReference: $projectReference, input: $input) {
    emailSent
    outcome
    userId
  }
}

json

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "input": {
    "email": "[email protected]",
    "role": "admin"
  }
}