Set a time alarm
set_time_alarmSets an alarm that rings on the person's phone at a clock time: once on a date, or on repeating days of the week. For a moment on the clock (a wake-up, a meeting, a reminder); it does not watch anything online, and an event with a Luma or Partiful link is a different alarm. Takes the time and an IANA time zone, plus either a date or repeat days, never both. People added to a friends alarm are notified, and email addresses with no LFG account get an invitation. Returns the alarm, when it next rings, its link and a share picture.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Date of a one-off alarm, "2026-11-02". Not used for a repeating alarm. | |
| note | No | A note from the person about the alarm, in their words, shown under its trigger on the alarm's page and in the Daily drop. Up to 500 characters; an empty note clears it. | |
| time | Yes | 24-hour time, "07:30". | |
| vibe | No | The feel of the alarm in a few words, "fun poppy anime", "calm", "a simple bell", "hype for a token launch". LFG picks a sound and a drawn look from its library to match; wallpaper words or colours given here win over the look. | |
| reach | No | Who can join: private (only the person), friends (people on its list, or with its link), public (anyone; listed in Discover). | private |
| theme | No | A picture theme: the alarm gets one of the theme's pictures as its wallpaper and a song in its moods, and a new alarm a title written for it. A wallpaper, title or vibe given as well is kept instead. One of: birthday (Birthday), love (Love), night_out (Night out), shopping (Shopping), winter (Winter), christmas (Christmas), hanukkah (Hanukkah), diwali (Diwali), halloween (Halloween), thanksgiving (Thanksgiving), friendsgiving (Friendsgiving), new_years (New Year's Eve). | |
| title | No | Short name for the alarm, "Gym", "Flight to Lisbon". When absent, LFG names it. | |
| source | No | The event in another app this alarm is for, such as a meeting in the person's calendar. With the same source again, the person's existing alarm for it is changed (its time and title) instead of a second one being made. | |
| ring_at | No | together: everyone rings at the same moment, this time in time_zone. local: this clock time on each person's own phone, wherever they are. | together |
| surprise | No | For a friends alarm: keep it a surprise. People who join see a curtain instead of its title, picture, sound and note until it rings. Free on every plan. | |
| time_zone | Yes | The person's IANA time zone, "America/New_York". | |
| add_groups | No | For a friends alarm: names of the person's friend groups whose members to let in, "Family". Members get a notification. | |
| add_people | No | For a friends alarm: up to 20 people to let in, as usernames of the person's LFG friends or as email addresses. Friends get a notification; an email address with no LFG account gets an invitation. Any other username is refused. | |
| button_link | No | ||
| repeat_days | No | Days a repeating alarm rings, ["mon","tue","wed","thu","fri"]. Not used for a one-off. | |
| words_color | No | Colour of the words as hex, "#D7FF00". | |
| hide_trigger | No | Needed with surprise, true or false: whether to also keep back when and why it rings, so people who join only know that it will. A surprise is not made until it is given. | |
| snooze_times | No | How many times it can be snoozed: 3, 10 or unlimited. | |
| silent_snooze | No | true to snooze without the spoken roast LFG plays by default. | |
| snooze_minutes | No | Minutes each snooze lasts: 5, 10, 15, 30 or 60. | |
| wallpaper_color | No | Wallpaper background colour as hex, "#5B2BFF". | |
| wallpaper_words | No | Words drawn on the wallpaper, "WAKE UP"; a line break starts a new line. | |
| people_confirmed | No | Whether the person has confirmed the people and groups being added. Nobody is added or told without it. |