Hi {email},
\nYou have been invited. Click here to set your password.
\nOr copy this link: {url}
\n `,\n text: `Hi {email},\\n\\nAccept your invite here: {url}`,\n },\n})\n```\n\nAny field you omit falls back to the built-in default. You do not need to provide all three.\n\n---\n\n## Extra fields\n\nYou can collect additional information when sending an invite — for example a name or a role. Those values are stored with the invite and written directly onto the user document when the account is created. Each field name is also available as a placeholder in your email templates.\n\n```ts\npayloadInvite({\n userCollections: ['users'],\n fields: [\n {\n name: 'name',\n label: 'Full Name',\n required: true,\n },\n {\n name: 'role',\n label: 'Role',\n type: 'select',\n options: ['editor', 'viewer'],\n },\n ],\n})\n```\n\nThe admin will see these inputs in the **Invite User** drawer, below the email field. On account creation the values are spread onto the user document, so `name: 'Jane'` will set the `name` field on the `users` collection document.\n\n### Field options\n\n| Option | Type | Default | Description |\n| ---------- | -------------------- | ---------- | --------------------------------------------------------------- |\n| `name` | `string` | — | **Required.** Must match the field name on the user collection. |\n| `label` | `string` | Field name | Label shown in the invite form. |\n| `type` | `'text' \\| 'select'` | `'text'` | Input type rendered in the form. |\n| `options` | `string[]` | — | Required when `type` is `'select'`. |\n| `required` | `boolean` | `false` | Prevents the form from submitting if left empty. |\n\n### Using field values in email templates\n\nEvery field name is automatically available as a placeholder alongside `{url}` and `{email}`:\n\n```ts\npayloadInvite({\n fields: [{ name: 'name', label: 'Full Name' }],\n email: {\n subject: 'Hi {name}, your invitation is ready',\n html: 'Hi {name},
Click here to set your password.
',\n text: 'Hi {name},\\n\\nAccept your invite here: {url}',\n },\n})\n```\n\n---\n\n## API endpoints\n\nThe plugin registers three endpoints on the `plugin-invites` collection:\n\n| Method | Path | Auth | Description |\n| ------ | -------------------------------------- | -------- | ----------------------------------------------------- |\n| `POST` | `/api/plugin-invites/create` | Required | Creates an invite and sends the email |\n| `GET` | `/api/plugin-invites/validate?token=…` | None | Validates a token and returns the associated email |\n| `POST` | `/api/plugin-invites/accept` | None | Creates the user account and marks the invite as used |\n\n---\n\n## Requirements\n\n- Payload `^3.37.0`\n- An [email adapter](https://payloadcms.com/docs/email/overview) configured in Payload (nodemailer, Resend, etc.)\n- `serverURL` set in your Payload config\n","readmeFilename":"README.md"}