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

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

​
Returns

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

​
Example

"What will my Clients birthday autogift actually send?"

{
  "name": "goody_autogift_rules_preview",
  "arguments": { "workspace_id": "3f8a…", "autogift_rule_id": "6d2a…" }
}

{
  "card": {
    "id": "a7f9…",
    "name": "Happy Birthday Confetti",
    "image_url": "https://ongoody.com/cards/a7f9….png"
  },
  "message": "Happy birthday, {{firstname}}!",
  "from_name": "Jordan at Acme",
  "products": [
    {
      "product_id": "0f3c…",
      "name": "Cold Brew Starter Kit",
      "quantity": 1,
      "flex_amount": null
    }
  ],
  "expected_spend_per_send": {
    "est_group_total_low": 4200,
    "est_group_total_high": 5000
  }
}
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.