Skip to documentation
GenHealth - Renewals integration

Select Initial Renewal Candidates

Perform Select Initial Renewal Candidates through GenHealth - Renewals.

View as Markdown
renewal_select_initial_candidates
write

Inputs

  • start_date
    daterequired
    Start Date

    Required date in YYYY-MM-DD format.

  • end_date
    daterequired
    End Date

    Required date in YYYY-MM-DD format.

  • account_key
    text
    Account Key

    Optional text value.

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: true

  • use_local_agent
    boolean
    Use Local Agent

    Optional true-or-false value.

    Default: false

  • exclude_patients
    json
    Exclude Patients

    Optional JSON value.

  • assignment_plan_job_id
    text
    Assignment Plan Job Id

    Optional text value.

  • assignment_distribution_window_days
    number
    Assignment Distribution Window Days

    Optional numeric value.

    Default: 7

  • trigger_payload
    json
    Trigger Payload

    Optional 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
}
View all GenHealth - Renewals actions