Leads & Contacts
The Maxwork Public API offers a simple and secure way for developers to create new leads within our system. By integrating our API, you can seamlessly enable lead creation functionality in your applications, allowing users to generate new leads directly from your platform.
To use our API, authentication is required via a token and username. To obtain these credentials, please contact our team.
Required fields: Essential for creating leads and contacts.
Optional fields: Used to further qualify the details of a lead or contact.
The /listingexport/leads endpoint is a universal endpoint for creating, updating, and archiving leads, contacts, and qualifications.
The type of entity is defined by Lead_Status & Optional properties.
Headers
Content-Type
application/json
user
user-agent
Listing Identification Fields
As Maxwork exports listings to other portals, one of the main types of identifications on the external portals is the public_reference.
Parameter
Description
Required
Public_Reference
The maxwork public reference of the listing (its exposed on all public portals), for Manual Leads you need to add the "None" value
True
Lead Information Fields
These parameters are used both to create leads and contacts
Parameter
Description
Required
Sender_Name
The name of the contact/lead.
True
Sender_Email
The email of contact/lead.
True
Sender_Phone
The phone number of the contact/lead.
True
Message
The message on the lead
True
Lead_Status
New, Contacted, Archived
True
Create a new Lead
POST /listingexport/leads?token=<token>
For leads created on API we may need a endpoint to map our entity ID to your Database. We do this to map entities to the correct information and to provide a good integration history.
Body Example
Response
Mark Lead as Contacted
By doing this if the contact does not exist we'Il create one.
The existion of an contact is evalueted by MobilePhone, Email and Agent related to the contact. If a contact with the same information exists for the Agent, the information of the lead is mapped for that contact.
POST /listingexport/leads?token=<token>
Body Example
Response
Mark Lead as Archived
POST /listingexport/leads?token=<token>
Body Example
Response
Last updated