## InviteRequest interface

**Signature:**

```typescript
export interface InviteRequest
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [access?](/content/docs/sdk/core.inviterequest.access) |  | ProjectMembershipAccess\[\] | _(Optional)_ |
| [accessPolicy?](/content/docs/sdk/core.inviterequest.accesspolicy) |  | Reference<AccessPolicy> | _(Optional)_ |
| [admin?](/content/docs/sdk/core.inviterequest.admin) |  | boolean | _(Optional)_ |
| [email?](/content/docs/sdk/core.inviterequest.email) |  | string | _(Optional)_ |
| [externalId?](/content/docs/sdk/core.inviterequest.externalid) |  | string | _(Optional)_ |
| [firstName](/content/docs/sdk/core.inviterequest.firstname) |  | string |  |
| [forceNewMembership?](/content/docs/sdk/core.inviterequest.forcenewmembership) |  | boolean | _(Optional)_ |
| [lastName](/content/docs/sdk/core.inviterequest.lastname) |  | string |  |
| [membership?](/content/docs/sdk/core.inviterequest.membership) |  | Partial<ProjectMembership> | _(Optional)_ |
| [mfaRequired?](/content/docs/sdk/core.inviterequest.mfarequired) |  | boolean | _(Optional)_ |
| [password?](/content/docs/sdk/core.inviterequest.password) |  | string | _(Optional)_ |
| [patient?](/content/docs/sdk/core.inviterequest.patient) |  | Reference<Patient> | _(Optional)_ The patient that a newly provisioned `RelatedPerson` is related to. Required when inviting a `RelatedPerson` without an existing `membership.profile`, since `RelatedPerson.patient` is a required FHIR field. |
| [resourceType](/content/docs/sdk/core.inviterequest.resourcetype) |  | 'Patient' \| 'Practitioner' \| 'RelatedPerson' |  |
| [scope?](/content/docs/sdk/core.inviterequest.scope) |  | 'project' \| 'server' | _(Optional)_ |
| [sendEmail?](/content/docs/sdk/core.inviterequest.sendemail) |  | boolean | _(Optional)_ |
| [upsert?](/content/docs/sdk/core.inviterequest.upsert) |  | boolean | _(Optional)_ |