Lead

Save lead
POST /api/savelead

Save a new lead and add it to EzzyCRM dashboard. Note you can select the pipeline to add the lead if you have multiple pipelines

Header parameters
Required Parameters Type Description
api_key  String   
Required
 Api key of the account
api_pwd  String   
Required
 Api password of the account
Body parameters
Required Parameters Type Description
FirstName  String   
Required
 The first name of a person with this lead will be linked to
LastName  String   
Required
 The last name of a person with this lead will be linked to
Email  String  The email of a person
Title  String  The job title of a person
PhoneType  String  The phone type of a person
Phone  String  The phone of a person
Remark  String  The remark of a person
OrganizationName  String   
Required
 The organization name of a person
Address1  String  The address1 of the organization
Address2  String  The address2 of the organization
City  String  The city of the organization
ZipCode  String  The zipcode of the organization
StateName  String  The state of the organization
CountryName  String  The country of the organization
IndustryName  String  The industry of the organization
UserId  Number   
Required
 ID of the user who will be marked as the owner of this lead
DealTitle  String   
Required
 The name of the lead
DealValue  String  The value of the lead
DealValueCurrency  String  The currency of the lead
NoteModel  String  Note of the lead
PipelineId  Number   
Required
 ID of the pipeline who will be marked as the owner of this lead
ExpectedCloseDate  String  The date of when the lead which will be created from the Lead is expected to be closed. format: MM/DD/YYYY
CustomField1  String  Custom1 field if created then enter here
CustomField2  String  Custom2 field if created then enter here
CustomField3  String  Custom3 field if created then enter here
CustomField4  String  Custom4 field if created then enter here
CustomField5  String  Custom5 field if created then enter here
CustomField6  String  Custom6 field if created then enter here
CustomField7  String  Custom7 field if created then enter here
CustomField8  String  Custom8 field if created then enter here
CustomField9  String  Custom9 field if created then enter here
CustomField10  String  Custom10 field if created then enter here
            
Example URL to POST to:
https://ezzycrm.com/api/savelead

Example Request:
{ 
"ContactModel":  
{
"FirstName": "John",
"LastName": "Roy",
"Email": "Johnroy@ezzycrm.com",
"Title": "",
"Phone": "0123456789",
"PhoneType": "Work",
"Remark": ""
},
"OrganizationModel":  
{
"OrganizationName": "Organization",
"Address1": "Add1",
"Address2": "Add2",
"City": "Mumbai",
"ZipCode": "400084",
"StateName": "Maharashtra",
"CountryName": "India",
"IndustryName": "Software"
 },
"UserId": 872,
"DealTitle": "Deal title",
"DealValue": "415.00",
"DealValueCurrency": "INR",
"NoteModel": [ 
    "Note1",
    "Note2"
    ],
"PipelineId": 764,
"ExpectedCloseDate": "06/10/2022",
"CustomField1": "",
"CustomField2": "",
"CustomField3": "",
"CustomField4": "",
"CustomField5": "",
"CustomField6": "",
"CustomField7": "",
"CustomField8": "",
"CustomField9": "",
"CustomField10": ""
}

Returns a 200 on success with the data for
the create lead status in the response:
{
"isSuccess": "true",
"data": [ 
    {
    "AccountId": 174,
    "UserId": 872,
    "DealId": 30489,
    "PipelineId": 764,
    "DealTitle": "Deal title",
    "DealValue": "415.00"
    }
],
"error": []
}

If there are any issues regarding the create lead status,
you will still get a 200 response,
but the response will include an additional 'errors` field
with details about the created lead.
{
"isSuccess": "false",
"data": [],
"error": [ 
    {
    "errorField": "Error Field Name",
    "errorMessage": "Error Message"
    }
]
}


Update status

Update lead status
POST /api/updateleadstatus

Update the lead status of a lead

Header parameters
Required Parameters Type Description
api_key  String   
Required
 Api key of the account
api_pwd  String   
Required
 Api password of the account
Body parameters
Required Parameters Type Description
DealId  Number   
Required
 ID of the lead
UserId  Number   
Required
 ID of the user who is marked as the owner of this lead
DealStatus  String   
Required
 Status for update of this lead
Value: Won Lost
LostReasonId  Number  ID of the reason is required when lead status is lost
Comments  String  Comments for lost of this lead
            
Example URL to POST to:
https://ezzycrm.com/api/updateleadstatus

Example request:
{
"DealId": 30489,
"UserId": 872,
"DealStatus": "Lost",
"LostReasonId": 764,
"Comments": ""
 }

Returns a 200 on success with the data for
the updated lead status in the response:
{
"isSuccess": "true",
"data": [ 
    {
    "AccountId": 174,
    "DealId": 30489
    }
],
"error": []
}

If there are any issues regarding the updated lead status,
you will still get a 200 response,
but the response will include an additional 'errors` field
with details about the updated lead status.
{
"isSuccess": "false",
"data": [],
"error": [ 
    {
    "errorField": "Error Field Name",
    "errorMessage": "Error Message"
    }
]
}


Update stage

Update lead stage
POST /api/updateleadstage

Update the lead stage of a lead

Header parameters
Required Parameters Type Description
api_key  String   
Required
 Api key of the account
api_pwd  String   
Required
 Api password of the account
Body parameters
Required Parameters Type Description
DealId  Number   
Required
 ID of the lead
UserId  Number   
Required
 ID of the user who is marked as the owner of this lead
DealStageCode  String   
Required
 Stage code for update of this lead
PipelineId  Number   
Required
 ID of the Pipeline who is marked as this lead
            
Example URL to POST to:
https://ezzycrm.com/api/updateleadstage

Example request:
{
"DealId": 30489,
"UserId": 872,
"DealStageCode": "FUP",
"PipelineId": 764
}

Returns a 200 on success with the data for
the updated lead stage in the response:
{
"isSuccess": "true",
"data": [ 
    {
    "AccountId": 174,
    "DealId": 30489
    }
],
"error": []
}

If there are any issues regarding the updated lead stage,
you will still get a 200 response,
but the response will include an additional 'errors` field
with details about the updated lead stage.
{
"isSuccess": "false",
"data": [],
"error": [ 
    {
    "errorField": "Error Field Name",
    "errorMessage": "Error Message"
    }
]
}


Update assign

Update assign lead
POST /api/assignlead

Update the assigned user of a deal

Header parameters
Required Parameters Type Description
api_key  String   
Required
 Api key of the account
api_pwd  String   
Required
 Api password of the account
Body parameters
Required Parameters Type Description
DealId  Number   
Required
 ID of the lead
UserId  Number   
Required
 ID of the user who is marked as the owner of this lead
PipelineId  Number   
Required
 ID of the Pipeline who is marked as this lead
DealAssignUserId  Number   
Required
 ID of the assign user
            
Example URL to POST to:
https://ezzycrm.com/api/assignlead

Example request:
{
"DealId": 30489,
"UserId": 872,
"PipelineId": 764,
"DealAssignUserId": 124
}

Returns a 200 on success with the data for
the updated lead stage in the response:
{
"isSuccess": "true",
"data": [ 
    {
    "AccountId": 174,
    "DealId": 30489
    }
],
"error": []
}

If there are any issues regarding the updated lead stage,
you will still get a 200 response,
but the response will include an additional 'errors` field
with details about the updated lead stage.
{
"isSuccess": "false",
"data": [],
"error": [ 
    {
    "errorField": "Error Field Name",
    "errorMessage": "Error Message"
    }
]
}


TOP