beneficiary
- base
- localhost
- dev
- prod
/v2/private/salesAgent/lead/:id/beneficiary
http://localhost:1350/v2/private/salesAgent/lead/:id/beneficiary
https://dev.everdays.com/v2/private/salesAgent/lead/:id/beneficiary
https://everdays.com/v2/private/salesAgent/lead/:id/beneficiary
Available Methods​
POST /v2/private/salesAgent/lead/:id/beneficiary​
This endpoint is used by Sales Agents / Counselors to add a beneficiary for the lead.
The beneficiary can either be the Plan Manager (type='manager') or a standard beneficiary (type='standard').
info
The user calling this endpoint must be Sales Agent / Counselor or Everdays Admin
Params​
| Param | Type | Description |
|---|---|---|
type | Enum - ['manager', 'standard'] | The type of the beneficiary, Plan Manager or standard. |
firstName | String | The beneficiary's first name. |
lastName | String | The beneficiary's last name. |
relationship | Enum - ['spouse', 'mother', 'father', 'daughter', 'son', 'brother', 'sister', 'cousin', 'aunt', 'uncle', 'grandfather', 'grandmother', 'grandchild', 'niece', 'nephew'] | The beneficiary's relationship to the lead. |
email | String | The beneficiary's email address. |
phone (Optional) | Number | The beneficiary's phone number. |
profile (Optional) | String | See rq-api. |
Example request body
body: {
"type": "manager",
"firstName": "Ben",
"lastName": "Eficiary",
"email": "ben@eficiary.com",
"relationship": "brother",
"percentage": 60,
"phone": 9495551115
}
Returns​
The lead's user object.
Example return object of just user
user: {
...
}
PUT /v2/private/salesAgent/lead/:id/beneficiary​
This endpoint is used by Sales Agents / Counselors to edit a lead's beneficiary.
info
The user calling this endpoint must be Sales Agent / Counselor or Everdays Admin
Params​
| Param | Type | Description |
|---|---|---|
beneficiaryId | String | The _id of the beneficiary to edit. |
firstName | String | The beneficiary's first name. |
lastName | String | The beneficiary's last name. |
relationship | Enum - ['spouse', 'mother', 'father', 'daughter', 'son', 'brother', 'sister', 'cousin', 'aunt', 'uncle', 'grandfather', 'grandmother', 'grandchild', 'niece', 'nephew'] | The beneficiary's relationship to the lead. |
email | String | The beneficiary's email address. |
phone (Optional) | Number | The beneficiary's phone number. |
profile (Optional) | String | See rq-api. |
Example request body
body: {
"beneficiaryId": "64909ce5554638ae95e44b24",
"firstName": "Ben",
"lastName": "Eficiary",
"email": "ben@eficiary.com",
"relationship": "brother",
"percentage": 60,
"phone": 9495551115
}
Returns​
The lead's user object.
Example return object of just user
user: {
...
}
DELETE /v2/private/salesAgent/lead/:id/beneficiary​
This endpoint is used by Sales Agents / Counselors to delete a beneficiary from the lead.
info
The user calling this endpoint must be Sales Agent / Counselor or Everdays Admin
Params​
| Param | Type | Description |
|---|---|---|
beneficiaryId | String | The _id of the beneficiary to delete. |
Example request body
body: {
"beneficiaryId": "64909caf554638ae95e44b22"
}
Returns​
The lead's user object.
Example return object of just user
user: {
...
}