createLead
- base
- localhost
- dev
- prod
/v2/private/salesAgent/createLead
http://localhost:1350/v2/private/salesAgent/createLead
https://dev.everdays.com/v2/private/salesAgent/createLead
https://everdays.com/v2/private/salesAgent/createLead
Available Methods​
- POST
POST /v2/private/salesAgent/createLead​
This endpoint is used by a Sales Agent / Counselor to create a new lead.
info
The user calling this endpoint must be Sales Agent / Counselor or Everdays Admin
Params​
| Param | Type | Description |
|---|---|---|
firstName | String | The lead's first name. |
lasteName | String | The lead's last name. |
dateOfBirth | Date | The lead's birthday. |
gender | Enum - ['Male', 'Female'] | The lead's gender. |
phone | Number | The lead's phone number. |
email | String | The lead's email address. |
state | String | The lead's state. |
Example request body
body: {
firstName: "Bobby",
lastName: "Boucher",
dateOfBirth: "01-01-1998",
gender: "Male",
phone: "3105551234",
email: "waterboy@sclu.edu",
state: "LA"
}
Returns​
The created lead's user object.
Example return object of just user
user: {
...
}