Prepare Initial Renewal Send Schedule
Perform Prepare Initial Renewal Send Schedule through GenHealth - Renewals.
renewal_prepare_initial_send_schedulewrite
Inputs
- Scheduled Date
scheduled_datedaterequiredRequired date in YYYY-MM-DD format.
- Account Key
account_keytextOptional text value.
- Lead Days
lead_daysnumberOptional numeric value.
Default:
62 - Dry Run
dry_runbooleanOptional true-or-false value.
Default:
false - Use Local Agent
use_local_agentbooleanOptional true-or-false value.
Default:
false - Assignment Distribution Window Days
assignment_distribution_window_daysnumberOptional numeric value.
Default:
7 - Trigger Payload
trigger_payloadjsonOptional JSON value.
Outputs
should_processShould Processdry_runDry Runend_dateEnd Datestart_dateStart Dateaccount_keyAccount Keyuse_local_agentUse Local Agentassignment_plan_job_idAssignment Plan Job Idassignment_distribution_window_daysAssignment Distribution Window Days
Output schema completeness: best_effort_declared
Safety
- External effect
- write
- Confirmation recommended
- No
- Retry safe
- No
- Dry run supported
- Yes
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"required": [
"scheduled_date"
],
"properties": {
"dry_run": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"lead_days": {
"type": "number",
"default": 62,
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
},
"account_key": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"scheduled_date": {
"type": "string",
"format": "date",
"description": "Required date in YYYY-MM-DD format.",
"x-workflow-field-type": "date"
},
"trigger_payload": {
"description": "Optional JSON value.",
"x-workflow-field-type": "json"
},
"use_local_agent": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"assignment_distribution_window_days": {
"type": "number",
"default": 7,
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"dry_run": {},
"end_date": {},
"start_date": {},
"account_key": {},
"should_process": {},
"use_local_agent": {},
"assignment_plan_job_id": {},
"assignment_distribution_window_days": {}
},
"additionalProperties": true
}