Set the nudge plan
set_nudge_planSets when Nudges (reminder emails) go out for every Chase, including ones already running, counted from the date Clients are asked to send by (the ask-by date): days before it, on the day, and days after it, sent at 09:00 UK time on weekdays. A value left out keeps its current setting. Returns the plan in words and this Quarter's remaining nudge dates. Use this when: the practitioner wants reminders on different days. Not for: one extra reminder now (send_nudges_now), one Client (pause_nudges), or the ask-by date itself (update_practice).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days_after | No | 1–60, up to 6 values: days after it | |
| on_the_day | No | also nudge on the ask-by date itself | |
| days_before | No | 1–60, up to 6 values: days before the date clients are asked to send by | |
| idempotency_key | No | Optional; reuse when retrying so the change happens once. |