Boostapp API For Developers

The API is an integral component of the Boostapp platform, enabling developers to programmatically access and update data within a Boostapp account.

Before you begin, it is important to be aware of the following:

Each business within the Boostapp platform will be provided with a unique API key. This key can be accessed from the Settings page, under the 'API KEY' section, at the following URL:

https://login.boostapp.co.il/office/BusinessSettings.php#generalsettings

Error Manual

The Boostapp API returns the following error codes in relevant scenarios:

Status Code	Meaning	Description
400	Client Already Exists	A customer with this phone number already exists.
401	Invalid API key format	Please provide a valid access token to proceed with the request.

Create New Lead

API URL

https://rest.lee.co.il/leads/create-new-lead

Method: Post
Headers:
- In the key field, enter x-api-key.
- In the value field, enter your API KEY.

Request Sample

{
   "clientData": {
       "fullName": "John Doe",
       "phone": "0501234567"
   },
   "pipeline": {},
   "subscription": {}
}

Response Sample

{
   "success": true,
   "code": 200,
   "data": {
        "clientID": 430069233
   }
}

Body Params

Select the raw option.

CLIENT DATA

Request Sample

{
   "clientData": {
       "fullName": "John Doe",
       "phone": "0501234567",
       "email": "test@boostapp.co.il",
       "remarks": "enter example text here",
       "birthDate": "1990-12-31",
       "gender": 0
   },
   "pipeline": {},
   "subscription": {}
}

Parameter	Description	Type	Info
fullName	String	Required	leads full name
phone [0501234567]	String	Required	leads contact number
email	String	Optional	leads email
remarks	String	Optional	Additional parameters can be included as needed.
birthDate [yyyy-mm-dd]	String	Optional	leads birth date
gender	INT	Optional	0 - Other 1 - Male 2 - Female

PIPELINE

Request Sample

{
   "clientData": {
       "fullName": "John Doe",
       "phone": "0501234567"
   },
   "pipeline": {
       "stage": 17297,
       "leadSource": 5079
   },
   "subscription": {}
}

Parameter	Description	Type	Info
Stage	INT	Optional	System Number – Indicates the stage in the pipeline where the lead will be created.
leadSource	INT	Optional	System Number – Identifies the source from which the lead was generated.

Stage

The stage can be found on the Pipeline page, under the settings section.
The system number (ID) is displayed next to each stage.

You can access the Pipeline settings here:

https://login.boostapp.co.il/office/manage-pipeline.php

leadSource

The leadSource can be found on the Pipeline page, under the settings section.
The system number (ID) is displayed next to each source.

Access the Pipeline settings here:

https://login.boostapp.co.il/office/manage-pipeline.php

SUBSCRIPTION

Request Sample

{
   "clientData": {
       "fullName": "John Doe",
       "phone": "0501234567"
   },
   "pipeline": {},
   "subscription": {
       "itemId": 109869
   }
}