Lead Updates using the Laminin API

Laminin exposes RESTful API endpoints that can be used to update existing leads on Laminin by external lead sources such as a third party system using the PUT HTTP method. This article will detail the available options and methodology.

Please note this document uses examples of the non-production environment of Laminin.

Production endpoints and credentials will be supplied upon request.

AUTHENTICATION

Each transaction header must have a key value pair for authentication where the value is the API Key:

• Key: X-Laminin-Client-ID
• Value: {apiKey} to be provided by Laminin

    Header Postman Example:

UPDATE LEAD STATE

Endpoint

The following URL can be used to update lead states in Laminin systematically:

• https://dev-extapi.lamin.in/api/web-hooks/ leads/{leadId}/{stateId}
• The {leadId} is the unique reference to the lead as it exists in Laminin
• The {stateId} represents the target state and is visible from the admin interface in Laminin under the Workflow section

Transaction Payload

No payload is required 

UPDATE LEAD FIELDS

Endpoint

The following URL can be used to update lead states in Laminin systematically:

• https://dev-extapi.lamin.in/api/web-hooks/ leads/{leadId}/update-fields
• The {leadId} is the unique reference to the lead as it exists in Laminin

 Transaction Payload

The payload is a JSON object with key value pairs. The campaign fields can be updated based on their unique keys. These keys are visible from the Laminin interface under the respective campaigns.

JSON Example:

{

    "IdNumber": "7812110000080"

    "FirstName": "Wade",

    "LastName": "Wilson",

    "MobilePhone": "0812345678",

    "AlternatePhone": "0100546546",

    "Email": "wade@dead.pool"

}

Please note that the field keys are case sensitive and must correspond 100% to the field keys on Laminin; i.e.: FirstName cannot be Firstname or First_Name. 

UPDATE LEAD STATE & FIELDS

Endpoint

The following URL can be used to update lead states in Laminin systematically:

• https://dev-extapi.lamin.in/api/web-hooks/leads/{leadId}/update-fields-and-state/{stateId}
• The {leadId} is the unique reference to the lead as it exists in Laminin
• The {stateId} represents the target state and is visible from the admin interface in Laminin under the Workflow section

 Transaction Payload

The payload is a JSON object with key value pairs. The campaign fields can be updated based on their unique keys. These keys are visible from the Laminin interface under the respective campaigns.

JSON Example:

{

    "IdNumber": "7812110000080"

    "FirstName": "Wade",

    "LastName": "Wilson",

    "MobilePhone": "0812345678",

    "AlternatePhone": "0100546546",

    "Email": "wade@dead.pool"

}

Please note that the field keys are case sensitive and must correspond 100% to the field keys on Laminin; i.e.: FirstName cannot be Firstname or First_Name.

TRANSACTION RESPONSE

Upon successful submission a JSON object will be returned with 2 parameters:

1. Success: True or False
2. Message: Contains information upon unsuccessful transaction

For any questions or additional support, please mail our team at support@lamin.in 

When logging a ticket with the Laminin support team, please provide as much information as possible. This can include references to specific leads or recordings as well as descriptions and screenshots of your own troubleshooting.