API Service Documentation

Command: policy_set

Creates a new lead in the CRM.

Request

NameTypeRequiredExample
modeStringYinsert/update

'insert' or 'update' - if mode is 'update' then 'policy_id' is required

policy_idIntegerN123456

Polciy id to (only required for "update" mode)

lead_idIntegerY123456

The lead this policy belongs to

policy_nameStringNMEDICARE ADVANTAGE

The type/name of the policy

policy_numberStringNACC63123
primary_agentIntegerN1001

The CRM userID owner of this policy

agent_agencyStringNBob Smith

Name of Primary Agent

ownerStringNJane Doe

Name of person who owns this policy

carrierStringNAetna

Name of policy carrier

premiumDecimalN123.45

Annual Primium Amount

issued_premium_amountStringN123.45

Premium Amount at time of issuance

cash_valueStringN123.45

Cash value or "Face Amount"

policy_notes_nvJSON Encoded StringN{"Field Name": "Val 1", "Pretty Two": "Value 2"}

Will be converted into HTML Notes like <b>Field:</b> value<br>

sourceStringNapi

Value shoule be "api" or "auto issued" if it came from a parser file

effective_dateDateTimeN2021-03-01

Date the policy went into effective

status_dateDateTimeN2021-03-01

Also "Case Submision Date" or "Application Date"

submitted_dateDateTimeN2021-02-25

Also "WRITTEN_DATE" or "AppSubmitDate"

statusStringNACTIVE

Should match values in the status conversion array (SUBMITTED, ACTIVE, LAPSED, CANCELED, DECLINED, etc)

source_submitted_idStringNX1234

ID Given prior to issue, also "NewCaseID"

source_issued_idStringNX1234

An issuance "PolicyID" other than Policy Number

paid_to_dateStringN2021-12-31

Also "DUE_DATE"

replacementYNNY

Y/N - "Y" means this policy is a replacement policy

modal_premiumDecimalN123.45

ARIS-Only Field

monthlyStringN12

ARIS-Only Field : 12=annual, etc

Response

NameTypeExample
statusInteger0
status_messageStringSuccess
policy_idInteger12345