Delete Bulk Leads

Deletes the details of a Leads object that has been previously created.

Parameters

Body Params
JSON:json
Leads details needs to be passed as body parameter,it should be in JSON format.
XML:string
Leads details needs to be passed as body parameter,it should be in XML format.
Path Params
yourCompany:string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Bulk-Leads will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Bulk-Leads
callback_urlstring
The callback URL need to passed in the base URL , which means after the code execution this file gets called.For eg. https://abc.php, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Bulk-Leads?callback_url=https://abc.php&key=xyzkey
In this case after execution of code the curl call will made on https://abc.php.
sendRecordNostring
The value as true or false need to passed for this parameter in the base URL.For eg. if you want record number with response then send value as true ,For eg.
https://xyzcompany.agiliron.net/agiliron/api-40.php/Bulk-Leads&key=xyzkey&sendRecordNo=true.
By default it will be false.
Header Params
Accept:string
Response header need to be passed for eg. application/json or application/xml.
Query Auth
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.
Header Auth
apiKey:string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code

{
    "Leads": {
        "Lead": [
            {
                "Email": "[email protected]"
            },
            {
                "Email": "[email protected]"
            }
        ]
    }
}
<Leads>
   <Lead>
      <Email>[email protected]</Email>
   </Lead>
   <Lead>
      <Email>[email protected]</Email>
   </Lead>
</Leads>

Sample Response

{
  "MCM": {
    "response": {
      "objectType": "Leads",
      "syncTime": "2021-06-11 04:13:24"
    },
    "parameters": {
      "results": {
        "message": {
          "status": "Success",
          "success_message": "Bulk Leads Delete Initiated Successfully.",
          "batch_id": "thggii1212kjkl"
        }
      }
    }
  }
}
<MCM>
    <response>
        <objectType>Leads</objectType>
        <syncTime>2021-06-11 04:13:24</syncTime>
    </response>
    <parameters>
        <results>
            <message>
                <status>Success</status>
                <success_message> Bulk Leads Delete Initiated Successfully. </success_message>
              	<batch_id>thggii1212kjkl</batch_id>
            </message>
        </results>
    </parameters>
</MCM>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="Bulk-Leads">
       <method name="DELETE">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="Email" type="xsd:string" style="body" required="true"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>

Sample Webhook

<?php
	$url = "https://{your_custom_url}"; //this custom url will be called after the code is executed
	$curlConn = curl_init();
	curl_setopt($curlConn, CURLOPT_CUSTOMREQUEST, "DELETE");
	curl_setopt($curlConn, CURLOPT_POSTFIELDS,$results); //$results contain the result set
	curl_setopt($curlConn,CURLOPT_URL,$url);
	curl_setopt($curlConn, CURLOPT_SSL_VERIFYHOST, 0);
	curl_setopt($curlConn, CURLOPT_SSL_VERIFYPEER, 0);
	curl_setopt($curlConn, CURLOPT_RETURNTRANSFER, 1);
	$ret = curl_exec($curlConn);
?>
<result>
   <SuccessNumber>1</SuccessNumber>
   <FailureNumber>1</FailureNumber>
   <Success>
      <Lead>
         <LeadId>123</LeadId>
         <LeadName>John Doe</LeadName>
      </Leads>
   </Success>
   <Failure>
      <Lead>
         <LeadId>456</LeadId>
         <Message>Lead Last Name cannot be blank</Message>
      </Lead>
   </Failure>
</result>
{
	"result": {
		"SuccessNumber": "1",
		"FailureNumber": "1",
		"Success": {
			"Lead": {
				"LeadId": "123",
				"LeadName": "John Doe"
			}
		},
		"Failure": {
			"Product": {
				"LeadId": "456",
				"Message": "Lead Last Name cannot be blank"
			}
		}
	}
}
<result>
   <SuccessNumber>1</SuccessNumber>
   <FailureNumber>1</FailureNumber>
   <Success>
      <Lead>
         <LeadId>123</LeadId>
         <LeadName>John Doe</LeadName>
         <Record>1</Record>
      </Lead>
   </Success>
   <Failure>
      <Lead>
         <LeadId>456</LeadId>
         <Message>Lead Last Name cannot be blank</Message>
         <Record>2</Record>
      </Lead>
   </Failure>
</result>
{
	"result": {
		"SuccessNumber": "1",
		"FailureNumber": "1",
		"Success": {
			"Lead": {
				"LeadId": "123",
				"LeadName": "John Doe",
				"Record": "1"
			}
		},
		"Failure": {
			"Product": {
				"LeadId": "456",
				"Message": "Lead Last Name cannot be blank",
				"Record": "2"
			}
		}
	}
}