Create account invitation

veryfront__create_account_invitation

Requires account.invitations.manage.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
emailstringYesInvitation recipient email. Only one pending invitation is allowed per email; another creation returns 409 until it is revoked or expires. Creation does not send email or reserve a seat; tier and seat capacity are checked when a new member accepts. Maximum length: 254. Format: email.
rolestringNoInvited administrator or member role. Defaults to administrator for existing clients. Default: "admin". Values: "admin", "member".
account_idstringYesProvide the account id. Format: uuid.

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.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__create_account_invitation",
    "arguments": {
      "email": "[email protected]",
      "account_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
idstringYesUnique identifier for the returned record. Format: uuid.
account_idstringYesThe account id returned by the tool.
emailstringYesThe email returned by the tool.
rolestringYesThe role returned by the tool. Values: "owner", "admin", "member".
statusstringYesPending invitations are reported as expired after expires_at. Values: "pending", "accepted", "revoked", "expired".
expires_atstringYesThe expires at returned by the tool.
invited_by_user_idstring or nullYesThe invited by user id returned by the tool.
accepted_by_user_idstring or nullYesThe accepted by user id returned by the tool.
resolved_atstring or nullYesThe resolved at returned by the tool.
created_atstringYesCreation timestamp in ISO 8601 format.
tokenstringYesRaw acceptance token. Returned exactly once; the server stores only its hash.

Full schemas

json
{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 254,
      "description": "Invitation recipient email. Only one pending invitation is allowed per email; another creation returns 409 until it is revoked or expires. Creation does not send email or reserve a seat; tier and seat capacity are checked when a new member accepts."
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "member"
      ],
      "default": "admin",
      "description": "Invited administrator or member role. Defaults to administrator for existing clients."
    },
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provide the account id."
    }
  },
  "required": [
    "email",
    "account_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the create_account_invitation tool."
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the returned record."
    },
    "account_id": {
      "$ref": "#/properties/id",
      "description": "The account id returned by the tool."
    },
    "email": {
      "type": "string",
      "description": "The email returned by the tool."
    },
    "role": {
      "type": "string",
      "enum": [
        "owner",
        "admin",
        "member"
      ],
      "description": "The role returned by the tool."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "accepted",
        "revoked",
        "expired"
      ],
      "description": "Pending invitations are reported as expired after `expires_at`."
    },
    "expires_at": {
      "type": "string",
      "description": "The expires at returned by the tool."
    },
    "invited_by_user_id": {
      "anyOf": [
        {
          "$ref": "#/properties/id",
          "description": "The invited by user id returned by the tool."
        },
        {
          "type": "null",
          "description": "The invited by user id returned by the tool."
        }
      ],
      "description": "The invited by user id returned by the tool."
    },
    "accepted_by_user_id": {
      "anyOf": [
        {
          "$ref": "#/properties/id",
          "description": "The accepted by user id returned by the tool."
        },
        {
          "type": "null",
          "description": "The accepted by user id returned by the tool."
        }
      ],
      "description": "The accepted by user id returned by the tool."
    },
    "resolved_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The resolved at returned by the tool."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    },
    "token": {
      "type": "string",
      "description": "Raw acceptance token. Returned exactly once; the server stores only its hash."
    }
  },
  "required": [
    "id",
    "account_id",
    "email",
    "role",
    "status",
    "expires_at",
    "invited_by_user_id",
    "accepted_by_user_id",
    "resolved_at",
    "created_at",
    "token"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the create_account_invitation tool."
}