Skip to main content
Permission: Read · Workspace: required (from goody_workspaces_list) Lists the autogift (recurring gift) rules in a workspace — the rules that send a gift automatically when a recipient hits a birthday, work anniversary, or onboarding milestone.

Parameters

string
required
Workspace UUID — from goody_workspaces_list. Rules in this workspace are returned.
string
Filter by rule state — one of active, paused, or inactive. Omit to return rules in all states.
integer
default:"1"
Page number, starting at 1.
integer
default:"25"
Results per page. Maximum 100.

Returns

object[]
The matching autogift rules.
integer
The current page number.
integer
Results per page.
integer
Total number of matching rules across all pages.

Example

Use a returned id with goody_autogift_rules_activate to turn a rule on, or goody_autogift_rules_pause to stop further sends.
To turn a listed rule on or off, use goody_autogift_rules_activate and goody_autogift_rules_pause.