The member object
Required properties
| Parameter | Type | Description |
|---|---|---|
first_name | String | The first name of the member. |
last_name | String | The last name of the member. |
has_sms_consent | Boolean | Set to true if member consents to receiving SMS. Accepts true or false, or the strings "true", "yes", "false" and "no" in any case. Any other value is rejected. When the member has a mobile_number or phone_number, an empty value is rejected, and null uses the SMS consent default set for your API application. Without either number, the member is recorded as not consenting, whatever is sent. |
Optional properties
| Parameter | Type | Description |
|---|---|---|
gender | String | The gender of the member. Only accepts Male or Female. |
birth_date | String | The birth date of the member. The date format should be YYYY-MM-DD. Example: 2020-12-31 |
is_married | Boolean | Set to true if the member is married. |
email | String | The email of the member. |
phone_number | String | The phone number of the member. Should be a valid US phone number. It is preferred if the phone number doesn't have any spaces, parentheses, and dashes. Example: 7195025680 |
mobile_number | String | The mobile number of the member. Should be a valid US mobile number. It is preferred if the phone number doesn't have any spaces, parentheses, and dashes. Example: 7195025680 |
occupation | String | The occupation of the member. |
household_relationship | String | The relationship of the member to the origin member. The accepted values are Self, Parent, Spouse, Son, Daughter, In-Law, Resident Relative, and Grandchild (case sensitive). |
height | String | The height of the member as any string description. |
weight | Float | The weight of the member in pounds as any float. |
is_tobacco_user | Boolean | Set to true if the member is is a tobacco user. |
has_pre_existing_conditions | Boolean | Set to true if the member has any pre-existing medical conditions. |
has_prescriptions | Boolean | Set to true if the member has any prescriptions. |
has_military_service | Boolean | Set to true if the member has any prior military experience. |
has_dui | Boolean | Set to true if the member has any prior DUIs. |
credit_rating | String | The member's credit rating. Can be either a description like 'Excellent' or a specific number. |
notes | String | A general field that can be used to provide more details, for example on pre-existing conditions if true. |
Example
{
"first_name": "Melvin",
"last_name": "Yost",
"gender": "Male",
"birth_date": "1975-12-21",
"is_married": true,
"email": "melvin.yost@goldnerwaelchi.name",
"phone_number": "8437041100",
"mobile_number": "8184086414",
"has_sms_consent": true,
"occupation": "Accountant",
"household_relationship": "In-Law",
"height": "5ft 9in",
"weight": 175.5,
"is_tobacco_user": false,
"has_pre_existing_conditions": true,
"has_prescriptions": null,
"has_military_service": true,
"credit_rating": "Excellent",
"has_dui": false,
"notes": "Pre-existing diagnosis of ..."
}