Skip to main content
Permission: Read · Workspace: not required (global) Generates three candidate gift-card messages for the user to pick from or refine. It works two ways — autopilot (category + sub_category) and collaborative (user_prompt) — and you can combine them: a category plus free-text instructions. Built-in categories include thank you, congratulations, birthday, work anniversary, welcome/onboarding, apology, sympathy, farewell, and holidays.

Parameters

category
string
A message category for autopilot mode — pair with sub_category (e.g. category "birthday"). One of: thank you, congratulations, birthday, work anniversary, welcome/onboarding, apology, sympathy, farewell, or holidays.
sub_category
string
A narrower variant within the chosen category. Use alongside category in autopilot mode.
user_prompt
string
Free text describing the message you want — e.g. “thank a client for sticking with us through a delay”. Required for collaborative mode; optional in autopilot mode as extra instructions on top of the category.
tones
string[]
default:"empty"
Free-text tone hints, e.g. ["warm", "professional"]. Defaults to empty.
formality_level
integer
default:"3"
How formal the message should read, from 1 (very casual) to 5 (formal). Defaults to 3.

Returns

messages
string[]
Exactly three candidate messages. Show them to the user and let them pick or refine.
Generated messages may contain the placeholder tokens {{firstname}} and {{fullname}} — Goody fills in each recipient’s real name at send time. Pass the chosen message through to goody_order_batches_create with the tokens unchanged. When you show a message to the user, render the token with the recipient’s actual name for a clean preview.

Example

"Draft a warm thank-you message for a client."
Once the user picks a message, carry the tokens through unchanged to goody_order_batches_create — Goody personalizes each recipient’s name at send time.