Skip to documentation
GenHealth - Renewals integration

Select Renewal Follow-Up Candidates

Perform Select Renewal Follow-Up Candidates through GenHealth - Renewals.

View as Markdown
renewal_select_subsequent_candidates
write

Inputs

  • attempt_type
    select
    Attempt Type

    Optional selected identifier or value.

    Default: "both"

    Options: Second Attempt ("2"), Third Attempt ("3"), Both ("both")

  • due_within_days
    number
    Due Within Days

    Optional numeric value.

  • min_days_between_attempts
    number
    Min Days Between Attempts

    Optional numeric value.

  • max_orders
    number
    Max Orders

    Optional numeric value.

  • states
    json
    States

    Optional JSON value.

  • account_key
    text
    Account Key

    Optional text value.

  • user_id
    number
    User Id

    Optional numeric value.

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: false

  • trigger_payload
    json
    Trigger Payload

    Optional JSON value.

Outputs

  • should_processShould Process
  • itemsItems
  • job_idJob Id
  • requestRequest

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",
  "properties": {
    "states": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "user_id": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "max_orders": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "account_key": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "attempt_type": {
      "enum": [
        "2",
        "3",
        "both"
      ],
      "type": "string",
      "default": "both",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "due_within_days": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "trigger_payload": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "min_days_between_attempts": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "items": {},
    "job_id": {},
    "request": {},
    "should_process": {}
  },
  "additionalProperties": true
}
View all GenHealth - Renewals actions