Invite someone to the household
invite_to_householdCreate a one-time link that lets another ask.recipes user join the user's household, for "add my wife to my household", "share my pantry with Sam", "connect my partner's account". The first call creates the household, so pass my_name (what the family calls the user) and optionally household_name. The person opens the link, enters their name and email, confirms a 6-digit code and is in; an account is created for them when they have none. On joining, their pantry merges into the shared one and their cooking diary becomes the household's. Give the user the link as is to forward; it works once and expires in a day. Up to 6 members, and an account can be in one household at a time.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| my_name | No | what the household calls the user, e.g. 'Dad' or 'Ana'; required the first time, when the household is created, and shown to the person invited | |
| household_name | No | a name for the household when creating it, e.g. 'Casa Silva' or 'Home'; defaults to Home |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| join_url | Yes | one-time link the user sends to the person joining; works once and expires in a day | |
| household | Yes | ||
| expires_in_hours | Yes |