Invite a collaborator
invite_collaboratorDestructive
Invite someone to collaborate on a doc the user OWNS, by email, so it lands in their docfarm. If they're already a docfarm user the doc appears in their farm immediately; if not, they get an invite email with a signup link. REQUIRES the collaborator's email AND allow_overwrite (true = their edits overwrite the original; false = their edits fork into a copy they own, auto-shared back to the inviter). If you don't have the email, ask for it. If the user hasn't said whether the person should edit directly or only make a copy, ask before calling — don't guess. Identify the doc via doc_name (fuzzy-matched) or slug.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | Share-link slug or full URL. Alternative to doc_name. | |
| Yes | Email address of the person to invite. | ||
| account | No | Email address of the farm to act on. Omit for the signed-in farm. Only a connected account is accepted; call list_accounts to see which. | |
| doc_name | No | Name of the doc to share. | |
| allow_overwrite | Yes | true = collaborator's edits overwrite the original; false = edits fork into a copy they own (auto-shared back to the inviter). |