Integrating Third-party Landing Pages Via API

Overview 
 AgentRoof CRM provides an API to integrate lead submissions from external websites or landing pages not developed by AgentRoof. This API allows users to send lead details directly to AgentRoof CRM. 
 Base URL 
 https://crm.v2.1.agentroof.com/api/add-lead 
 Request Method 
 
 
 POST : The API accepts POST requests to submit lead information. 
 
 
 Request Headers 
 The request headers must include the APPKEY , which serves as your CRM authentication key. Contact the AgentRoof support team to obtain your unique APPKEY (CRM Key). 
 Example Header: 
 
 
 
 
 
 
 
 
 APPKEY: your-crm-appkey-here 
 Request Body 
 The request body should be sent as form-data and include the following fields: 
 
 
 
 
 
 
 Field Name 
 
 
 Type 
 
 
 Required 
 
 
 Description 
 
 
 
 
 name 
 
 
 string 
 
 
 Yes 
 
 
 The full name of the lead. 
 
 
 
 
 email 
 
 
 string 
 
 
 Yes 
 
 
 The lead's email address (must be a valid email). 
 
 
 
 
 phone 
 
 
 string 
 
 
 Yes 
 
 
 The lead's phone number (must be a 10-digit number). 
 
 
 
 
 url 
 
 
 string 
 
 
 Yes 
 
 
 The URL of the website or landing page from which the form is submitted. 
 
 
 
 
 source 
 
 
 string 
 
 
 No 
 
 
 The lead source (default: website ). Can be customized. 
 
 
 
 
 stage 
 
 
 string 
 
 
 No 
 
 
 The lead's stage (default: Lead ). 
 
 
 
 
 tag 
 
 
 string 
 
 
 No 
 
 
 Tags associated with the lead (default: Buyer lead, Seller lead ). 
 
 
 
 
 
 
 
 Example Request Body: 
 name: John Doe
 email: john.doe@example.com
 phone: 1234567890
 url: <https://example-landingpage.com>
 source: Facebook
 stage: New Lead
 tag: Seller lead 
 Response 
 The API will return a JSON response indicating the success or failure of the lead submission. 
 Successful Response: 
 { 
 "status" : "success" , 
 "message" : "Lead added successfully" , 
 "data" : [ ] 
 } 
 Error Response: 
 If the request fails due to missing required fields or validation errors, the API will return a JSON response with details: 
 { 
 "status" : "error" , 
 "message" : "The email must be a valid email address.,The phone field is required." 
 } 
 Whitelisting IP Address 
 To ensure the API requests are not blocked by AgentRoof's firewall, you are required to share the IP address from which the requests will be made. Contact AgentRoof support to have your IP address whitelisted. 
 Important Notes 
 
 
 APPKEY : Always ensure the correct APPKEY is used in the request header. 
 
 
 IP Address Whitelisting : Failure to whitelist your IP address may result in the API request being blocked by AgentRoof's firewall. 
 
 
 Form-Data Submission : Ensure that all required fields are provided in the correct format to avoid validation errors. 
 
 
 For any additional assistance, please contact the AgentRoof support team.