Select Initial Renewal Candidates
Perform Select Initial Renewal Candidates through GenHealth - Renewals.
renewal_select_initial_candidateswrite
Inputs
- Start Date
start_datedaterequiredRequired date in YYYY-MM-DD format.
- End Date
end_datedaterequiredRequired date in YYYY-MM-DD format.
- Account Key
account_keytextOptional text value.
- Dry Run
dry_runbooleanOptional true-or-false value.
Default:
true - Use Local Agent
use_local_agentbooleanOptional true-or-false value.
Default:
false - Exclude Patients
exclude_patientsjsonOptional JSON value.
- Assignment Plan Job Id
assignment_plan_job_idtextOptional text value.
- Assignment Distribution Window Days
assignment_distribution_window_daysnumberOptional numeric value.
Default:
7 - Trigger Payload
trigger_payloadjsonOptional JSON value.
Outputs
No named outputs are declared for this action.
Output schema completeness: unknown
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": [
"start_date",
"end_date"
],
"properties": {
"dry_run": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"end_date": {
"type": "string",
"format": "date",
"description": "Required date in YYYY-MM-DD format.",
"x-workflow-field-type": "date"
},
"start_date": {
"type": "string",
"format": "date",
"description": "Required date in YYYY-MM-DD format.",
"x-workflow-field-type": "date"
},
"account_key": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"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"
},
"exclude_patients": {
"description": "Optional JSON value.",
"x-workflow-field-type": "json"
},
"assignment_plan_job_id": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"assignment_distribution_window_days": {
"type": "number",
"default": 7,
"description": "Optional numeric value.",
"x-workflow-field-type": "number"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {},
"additionalProperties": true
}