goody_autogift_rules_list - Goody Developers

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

workspace_id

string

required

Workspace UUID — from goody_workspaces_list. Rules in this workspace are returned.

status

string

Filter by rule state — one of active, paused, or inactive. Omit to return rules in all states.

page

integer

default:"1"

Page number, starting at 1.

per_page

integer

default:"25"

Results per page. Maximum 100.

Returns

autogift_rules

object[]

The matching autogift rules.

Show autogift_rule

string

Rule UUID — pass to goody_autogift_rules_activate or goody_autogift_rules_pause.

status

string

Rule state — active, paused, or inactive.

event_type

string

The occasion that triggers a send — e.g. birthday, work_anniversary, or onboarding.

contact_list

object

The contact list the rule watches.

Show contact_list

string

Contact list UUID.

name

string

The list’s visible name.

card_id

string | null

The greeting card chosen for the rule.

from_name

string | null

The “From” name recipients see.

message

string | null

The gift-card message template.

tenure_min

integer | null

Lowest years of service the rule applies to.

tenure_max

integer | null

Highest years of service the rule applies to.

created_at

string

When the rule was created.

page

integer

The current page number.

per_page

integer

Results per page.

total_count

integer

Total number of matching rules across all pages.

Example

"What autogifts do I have running?"

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.

​Parameters

​Returns

​Example

Parameters

Returns

Example