Skip to documentation
GenHealth - Renewals integration

Create Initial Renewal Assignment Plan

Perform Create Initial Renewal Assignment Plan through GenHealth - Renewals.

View as Markdown
renewal_prepare_initial_assignment_plan
write

Inputs

  • start_date
    date
    Start Date

    Optional date in YYYY-MM-DD format.

  • end_date
    date
    End Date

    Optional date in YYYY-MM-DD format.

  • scheduled_date
    date
    Scheduled Date

    Optional date in YYYY-MM-DD format.

  • target_months_ahead
    number
    Target Months Ahead

    Optional numeric value.

  • account_key
    text
    Account Key

    Optional text value.

  • use_local_agent
    boolean
    Use Local Agent

    Optional true-or-false value.

    Default: false

  • assignment_distribution_window_days
    number
    Assignment Distribution Window Days

    Optional numeric value.

    Default: 7

  • send_email
    boolean
    Send Email

    Optional true-or-false value.

    Default: false

  • to_emails
    json
    To Emails

    Optional JSON value.

  • cc_emails
    json
    Cc Emails

    Optional JSON value.

  • subject
    text
    Subject

    Optional text value.

  • greeting_name
    text
    Greeting Name

    Optional text value.

  • 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
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "properties": {
    "subject": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "cc_emails": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "to_emails": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "send_email": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "account_key": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "greeting_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "scheduled_date": {
      "type": "string",
      "format": "date",
      "description": "Optional 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"
    },
    "target_months_ahead": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "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