View as Markdown
White Swan icon

White Swan ACTION

Submit Complete Plan Request

Creates a new comprehensive quote request based on the information provided and generates the final quotation without further data requirements. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's White Swan account once, then configure and run Submit Complete Plan Request from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "white_swan-submit-complete-plan-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    white_swan: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    email: "Email",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Submit Complete Plan Request inputs
Property Type Description
name Name string
The full name of the person who the request is made on behalf of.
Required
email Email string
The email of the person who the request is made on behalf of.
Required
policyType Policy Type string
The policy type that this request is made for.
Required
mainGoal Main Goal string
The primary goal of this plan request, either Protection or Accumulation.
Required
residentState Resident State string
The state in which the insured person is a resident. Example: California
Required
deathBenefitNeeded Death Benefit Needed integer
The amount of death benefit that is required for this plan. To opt for the lowest amount possible given a certain premium budget, use 0.
Required
paymentSchedule Payment Schedule string
How often premiums should be paid on this plan.
Required
gender Gender string
Whether the intended insured person is Male or Female.
Required
dateOfBirth Date of Birth string
The date of birth of the intended insured person in ISO 8601 format.
Required
healthRating Health Rating string
How the insured person would rate their own general health.
Required
usesTobacco Uses Tobacco boolean
Whether the intended insured person uses tobacco/nicotine products or not.
Required
insuredHeightFeet Insured Height in Feet integer
The height in feet of the intended insured person.
Required
insuredHeightInches Insured Height in Inches integer
The height in inches of the intended insured person.
Required
insuredWeight Insured Weight integer
The weight in pounds of the intended insured person.
Required
prefillInfoId Pre-fill Info ID string
If you have already created a pre-fill information you can pass its ID by using this parameter to associate that info with this request.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
white_swan-submit-complete-plan-request
Version
0.0.3
App
White Swan
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes