objectives

base

/v2/private/engine/objectives

localhost

http://localhost:1350/v2/private/engine/objectives

dev

https://dev.everdays.com/v2/private/engine/objectives

prod

https://everdays.com/v2/private/engine/objectives

Available Methods

• POST

---

POST /v2/private/engine/objectives

This endpoint is used to save information on objectives for various steps in the engine flow.

Note

Each param does not need to be included with the request body, fields will be independently updated rather than be wiped if a value was missing with the request body.

Params

Param	Type	Description
enoughIncomeToRetire	Number [0-6] (Likert)	The
coverCareCosts	Number [0-6] (Likert)	The
coverFinalExpenses	Number [0-6] (Likert)	The
settlePosthumousBills	Number [0-6] (Likert)	The
policySize	Number [0-6] (Likert)	The
coveragePermanence	Number [0-6] (Likert)	The
willingnessToAnswerMoreQuestions	Boolean	Whether or not the user will want to answer future questions

Example request body

body: {
  "enoughIncomeToRetire": 5,
  "coverCareCosts": 3,
  "coverFinalExpenses": 3,
  "settlePosthumousBills": 6,
  "policySize": 3,
  "coveragePermanence": 2,
  "willingnessToAnswerMoreQuestions": true
}

Returns

The entire user object.

Example return object of just user.insurance

user: {
  insurance: {
    lostInsurance: {
      other: [],
      dental: false,
      health: false,
      life: true,
      vision: true
    },
    finances: {
      monthlyAllowance: 100,
      monthlyExpenses: 100,
      totalAssets: 10000
    },
    health: {
      bmi: 24,
      drinker: true,
      exerciser: true,
      height: 91,
      inCare: false,
      practiceSelfCare: false,
      seriousIllness: false,
      sleepWell: false,
      smoker: false,
      weight: 177
    },
    objectives: {
      coverCareCosts: 3,
      coverFinalExpenses: 3,
      coveragePermanence: 2,
      enoughIncomeToRetire: 5,
      policySize: 3,
      settlePosthumousBills: 6,
      willingnessToAnswerMoreQuestions: true
    }
  }
}

info

For more detailed information about each value in insurance, please refer to the user model docs.