Skip to main content
Permission: Write · Workspace: required (from goody_workspaces_list) Pauses an active rule so no further gifts are scheduled against its contact list. Reversible via goody_autogift_rules_activate.

​
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.

​
Returns

​
autogift_rule
object
The now-paused rule.

​
Example

"Pause my Clients birthday autogift."

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

{
  "autogift_rule": {
    "id": "6d2a…",
    "status": "paused",
    "event_type": "birthday",
    "contact_list": { "id": "d052…", "name": "Clients" },
    "card_id": "a7f9…",
    "from_name": "Jordan at Acme",
    "message": "Happy birthday, {{firstname}}!",
    "tenure_min": null,
    "tenure_max": null,
    "created_at": "2026-05-02T14:11:00Z"
  }
}
Turn the rule back on with goody_autogift_rules_activate, or browse all your rules with goody_autogift_rules_list.