Create invite

veryfront__create_invite

Requires project.invites.manage and an available collaboration seat. The result type determines whether id is a user or invitation ID; email_sent reports the notification send result, not inbox delivery.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Can change resources.

Arguments

Field	Type	Required	Description and constraints
`project_reference`	`string`	No	Project ID or slug
`email`	`string`	Yes	Email address of the user to invite Format: `email`.
`role`	`string`	No	Role to assign (default: editor) Values: `"admin"`, `"editor"`, `"viewer"`.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

request.json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__create_invite",
    "arguments": {
      "email": "[email protected]"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

Field	Type	Required	Description and constraints
`id`	`string`	Yes	User ID for USER_ADDED; invitation ID for INVITE_CREATED.
`email`	`string`	Yes	Email address submitted for the member or pending invitation.
`role`	`string`	Yes	Assigned project role.
`project_id`	`string`	Yes	Project UUID receiving the member or invitation.
`type`	`string`	Yes	USER_ADDED adds an existing account immediately; INVITE_CREATED creates a pending invitation. Values: `"USER_ADDED"`, `"INVITE_CREATED"`.
`email_sent`	`boolean`	Yes	Whether the email service accepted the notification send. This does not confirm inbox delivery.

Full schemas

{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the user to invite"
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "editor",
        "viewer"
      ],
      "description": "Role to assign (default: editor)"
    }
  },
  "required": [
    "email"
  ],
  "additionalProperties": false,
  "description": "Arguments for the create_invite tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "User ID for USER_ADDED; invitation ID for INVITE_CREATED."
    },
    "email": {
      "type": "string",
      "description": "Email address submitted for the member or pending invitation."
    },
    "role": {
      "type": "string",
      "description": "Assigned project role."
    },
    "project_id": {
      "type": "string",
      "description": "Project UUID receiving the member or invitation."
    },
    "type": {
      "type": "string",
      "enum": [
        "USER_ADDED",
        "INVITE_CREATED"
      ],
      "description": "USER_ADDED adds an existing account immediately; INVITE_CREATED creates a pending invitation."
    },
    "email_sent": {
      "type": "boolean",
      "description": "Whether the email service accepted the notification send. This does not confirm inbox delivery."
    }
  },
  "required": [
    "id",
    "email",
    "role",
    "project_id",
    "type",
    "email_sent"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_invite tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get started

APIs

REST API

GraphQL API

MCP API

Access

Arguments

Example request

Result

Full schemas

​Access

​Arguments

​Example request

​Result

​Full schemas

Access

Arguments

Example request

Result

Full schemas