Back to Medusa

CreateInviteDTO

www/apps/resources/references/user/interfaces/user.CreateInviteDTO/page.mdx

2.14.2935 B
Original Source

import { TypeList } from "docs-ui"

CreateInviteDTO

The invite to be created.

<TypeList types={[{"name":"email","type":"string","description":"The email of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accepted","type":"boolean","description":"Whether the invite is accepted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"roles","type":"null \| string[]","description":"The RBAC roles to assign to the user when the invite is accepted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CreateInviteDTO"/>