Share a website by email
share_serviceDestructive
Share a website with specific people by email, whether it is private or password-protected — sharing does not change who else can reach it. Each address is mailed a link from Valet that opens the site; the recipient needs no Valet account of their own, only the link, so anyone holding the email can open the site and forwarding it forwards access. Only websites can be shared by email so far; an app is refused. Sharing again with an address that already has access re-sends the same link rather than creating a second one. Requires connecting a Valet account.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | The kind you mean. Omit to share whatever the name holds; give it to have a name holding another kind refused. Only a website can be shared by email so far. | |
| name | Yes | Required. The website's name. | |
| emails | Yes | Required. The email addresses to share the site with, at most 10 at a time. Sharing again with an address that already has access re-sends the same link rather than creating a second one. | |
| message | No | An optional note included in the email, shown to the recipient as a quote beside the link. At most 500 characters. | |
| org_name | No | The Valet organization the site belongs to. Omit to use the organization the account joined first. | |
| access_ttl | No | How long the first open starts access for, after which the link stops working, such as 30m or 7d (units: s, m, h, d). Omit for access that never expires this way. Composes with expires_in: the unopened deadline governs until the first open replaces it. | |
| expires_in | No | How long from now the link works if nobody has opened it yet, such as 24h or 7d (units: s, m, h, d). Omit for a link that never expires this way. |