> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create invitation

> Create an invitation.

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

Requires project.invites.manage.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Project UUID or slug. |
| `input` | [`CreateProjectInvitationInput!`](https://veryfront.com/docs/cloud/graphql/types/createprojectinvitationinput) | Yes | |

## Input fields

### input

[`CreateProjectInvitationInput`](https://veryfront.com/docs/cloud/graphql/types/createprojectinvitationinput)

| Field | Type | Required | Description |
| - | - | - | - |
| `email` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | Email address to invite; stored in lowercase. |
| `role` | [`ProjectInvitationRole!`](https://veryfront.com/docs/cloud/graphql/types/projectinvitationrole) | Yes | |

## Response

Returns [`ProjectInvitationResult!`](https://veryfront.com/docs/cloud/graphql/types/projectinvitationresult). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `outcome` | [`ProjectInvitationOutcome!`](https://veryfront.com/docs/cloud/graphql/types/projectinvitationoutcome) | |
| `invitation` | [`ProjectInvitation`](https://veryfront.com/docs/cloud/graphql/types/projectinvitation) | The pending invitation; null when outcome is member\_added. |
| `userId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | The added user; set only when outcome is member\_added. |
| `emailSent` | [`Boolean!`](https://veryfront.com/docs/cloud/graphql/types/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](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
mutation CreateProjectInvitation($projectReference: ID!, $input: CreateProjectInvitationInput!) {
  createProjectInvitation(projectReference: $projectReference, input: $input) {
    emailSent
    outcome
    userId
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "input": {
    "email": "person@example.com",
    "role": "admin"
  }
}
```

<details>
  <summary>Try this mutation</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Mutation

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.