Skip to main content
Permission: Read · Workspace: required (from goody_workspaces_list) Previews what a paused autogift rule will send — the greeting card, message, product(s), and expected per-send cost — without sending, charging, or activating anything. Call it before goody_autogift_rules_activate and relay the result for confirmation.

Parameters

string
required
Workspace UUID — from goody_workspaces_list. The rule must belong to this workspace.
string
required
Rule UUID — from goody_autogift_rules_list or goody_autogift_rules_create.

Returns

object | null
The greeting card the rule will send.
string | null
The gift-card message template.
string | null
The “From” name recipients see.
object[]
The product(s) the rule will send.
object
Estimated cost for a single recipient, in cents.

Example

The message is shown as its raw template — personalization tags (e.g. the recipient’s first name) are filled per-recipient at send time, so no placeholder recipient is invented.
Once the preview looks right, turn the rule on with goody_autogift_rules_activate.