Skip to main content

categories

/v2/private/salesAgent/lead/:id/categories

Available Methods​

  • POST

POST /v2/private/salesAgent/lead/:id/categories​

This endpoint is used by Sales Agents / Counselors to edit a lead's coverage allocation categories.

info

The user calling this endpoint must be Sales Agent / Counselor or Everdays Admin

Params​

ParamTypeDescription
selectionsObjectAn object containing keys for each category.

selections object​

KeyTypeDescription
cemeteryBooleanAllocate for cemetery expenses.
funeralBooleanAllocate for funeral expenses.
heirsBooleanAllocate for Heirs.
charityBooleanAllocate for Charity.
billsBooleanAllocate for Bills.
otherBooleanOther Allocation.
caution

Make sure all categories are included in the request, whether they are true or false.

info

heirs will always be saved as selected: true, regardless of what is passed from the front-end

Example request body
body: {
"selections": {
"cemetery": true,
"funeral": true,
"heirs": true,
"charity": true,
"bills": false,
"other": true
}
}

Returns​

The lead's user object.

Example return object of just user
user: {
...,
life: {
...,
policyCoverage: {
cemetery: {
selected: true,
amount: 0
},
funeral: {
selected: true,
amount: 0
},
heirs: {
selected: true,
amount: 0
},
charity: {
selected: true,
amount: 0
},
bills: {
selected: false,
amount: 0
},
other: {
selected: true,
amount: 0
}
}
}
}