Skip to content
On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / inviteUser

Function: inviteUser()

inviteUser<Schema>(email, role, invite_url?): RestCommand<void, Schema>

Invite a new user by email.

Type parameters

Schema extends object


email: string

User email to invite.

role: string

Role of the new user.

invite_url?: string

Provide a custom invite url which the link in the email will lead to. The invite token will be passed as a parameter.


RestCommand<void, Schema>