Appearance

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 / inviteShare

Function: inviteShare() ​

inviteShare<Schema>(share, emails): RestCommand<void, Schema>

Sends an email to the provided email addresses with a link to the share.

Type parameters ​

• Schema extends object

Parameters ​

• share: string

Primary key of the share you're inviting people to.

• emails: string[]

Array of email strings to send the share link to.

Returns ​

RestCommand<void, Schema>

Nothing

Source ​

rest/commands/utils/shares.ts:33