Leads

This page details all the endpoints associated with leads.

Create a New Lead

POST https://api.patientsonboard.com/app/api/leads

firstName and either phone or email parameters are required.

Request Body

Name	Type	Description
firstName*	String
lastName	String
phone	String	Either a phone number or an email address is required.
email	String	Either a phone number or an email address is required.

200: OK In instances where a phone number or email is duplicated, or when we recognize a new lead as a potential duplicate, the "confirmed" value will be set to false. It's important to note that unconfirmed leads will not be included in GET all queries unless explicitly requested through URL queries.

{
    status : 200, 
    data : {
        leadID : xxx, 
        confirmed : true/false
    }
}

Update a Lead

PATCH https://api.patientsonboard.com/app/api/leads/:leadID

Query Parameters

Name	Type	Description
leadID*	String

Request Body

Name	Type	Description
firstName*	String
lastName	String
phone	String	Either a phone number or an email address is required.
email	String	Either a phone number or an email address is required.

200: OK

{
    status : 200, 
}

Get All Leads

GET https://api.patientsonboard.com/app/api/leads

Query Parameters

Name	Type	Description
search	String	Full Text Search could include names, phone or email addresses.
page	Number	default 1
limit	Number	default 25, possible values are 25, 50, 100

200: OK

{
    leads : [
        {
            firstName: "John", 
            lastName: "Doe", 
            email: "[email protected]", 
            phone: "123"
        }
    ],
    total : 100, 
    totalPages: 10
}

Get Single Lead

GET https://api.patientsonboard.com/app/api/leads/:leadID

Query Parameters

Name	Type	Description
leadID*	String

200: OK

{
    status: 200,
    data : {
      firstName: "John", 
      lastName: "Doe", 
      email : "[email protected]", 
      phone: "123"
    } 
}

Delete a Lead

DELETE https://api.patientsonboard.com/app/api/leads/:leadID

Query Parameters

Name	Type	Description
leadID*	String

200: OK

{
    status: 200
}