Lead API Updates

Data Updates

Changes can be submitted to a previously submitted lead or even to a lead in AdminBase that hasn’t come through the Lead API.

Submit a Change

To submit a change you POST the data (form-urlencoded/json) to

https://webleads.abinitiosoftware.co.uk/api/LeadDetailsUpdate

or

https://webleads.abinitiosoftware.co.uk/api/LeadDetailsUpdateBatch

Fields

The fields that can be updated are any of the fields available to the Lead API (List here) and the following:-

Payload

There are five key fields that need to be provided.

INS Fields

Although most fields can be updated there are two that cannot. For these fields the ChangeAction must be specified as “INS”. This will ensure there is no ambiguity about the desired action.

The two fields are NOTES and EMAIL. Providing these will either create a new note on the Lead within AdminBase or create a new email address and set it as the default.

UPD Fields

This is the ChangeAction you will want most of the time.

JSON Structure

Mentioned previously the LeadDetailsUpdateBatch endpoint takes an array of objects, this means the JSON has to follow the following structure for 1 or more objects:-

[
    {
        "AB_CUSTID": 98765,
        "AB_PWORD": "password",
        "leadnumber": 12345,
        "ChangeAction": "UPD",
        "ChangeTarget": "LEADS",
        "ChangeField": "POSTCODE",
        "ChangeValue": "GU3 1JH",
        "ChangeAuthor": "TOM"
    }
]

For one object - Using the credential collection

[
    {
        "token": "8548d5e0-9d47-4d08-b9ec-2e0d8689c712",
        "ChangeAction": "UPD",
        "ChangeTarget": "LEADS",
        "ChangeField": "RESULT",
        "ChangeValue": "Dead",
        "ChangeAuthor": "TOM"
    },
    {
        "token": "8548d5e0-9d47-4d08-b9ec-2e0d8689c712",
        "ChangeAction": "UPD",
        "ChangeTarget": "LEADS",
        "ChangeField": "RESULTDATE",
        "ChangeValue": "02/10/2024",
        "ChangeAuthor": "TOM"
    }
]

For two related objects - Using the token

Send with Token

It is possible to send an update to a lead already submitted through the Lead API by using the token. To do this you must supply the token provided to you by the API on submission of the lead originally.

Postman Example

An example of sending an update via Postman using the token from a previous lead submission

Send With Lead Number

It is also possible to send an update to a lead in AdminBase even if that lead didn’t arrive through the Lead API. To do this you must supply the lead number along with your Lead API credentials.

Postman Example

An example of sending an update via Postman using the Lead number and credentials

Files

Files can be attached to a previously submitted lead or even to a lead in AdminBase that hasn’t come through the Lead API. Files can be added at any time.

To Submit a Lead and Documents

A Lead is submitted in the usual fashion but with the added parameter TOKENREQ set to 1. This returns json like the following:

{
    "token": "8548d5e0-9d47-4d08-b9ec-2e0d8689c712"
}

This token value uniquely identifies the just submitted lead and can be used in a subsequent call to add a file to the lead.

You will need to send the following multipart form-data to https://webleads.abinitiosoftware.co.uk/api/Upload

Postman Example

An example of sending a file via Postman using the token from a previous lead submission

To Submit a Lead and Documents - JavaScript

Here is a simplified example of how to do this in JavaScript:

var handleSubmit = (event) => {
  //event.preventDefault();
  const form = document.getElementById("form");
  const inputFile = document.getElementById("file");
  const inputNote = document.getElementById("note");
  var formData = new FormData();
  //set values of formdata - these are the fields of the form i.e.
  formData.append("NOTES", inputNote.value);
  // ...
  formData.append("TOKENREQ", 1);
  formData.append("AB_CUSTID", "Your credentials");
  formData.append("AB_PWORD", "Your credentials"); 
  //send form data
  fetch("https://webleads.abinitiosoftware.co.uk/api/LeadDetails", {
    method: "post",
    body: formData,
  }).then((data) => { //if successful send file(s)
    for (const file of inputFile.files) {
      formData = new FormData();
      formData.append("file", file);
      formData.append("token", data.token);
      formData.append("description", file.name);
      formData.append("filename", file.name);
      fetch("https://webleads.abinitiosoftware.co.uk/api/Upload", {
        method: "post",
        body: formData,
      }).catch((error) => ("Something went wrong!", error));
    }
  }).catch((error) => ("Something went wrong!", error));
};

Where the html may look like:

<form id="form">
 <input type="text" id="note" />
 ...
 <input type="file" id="file" multiple />
 <button onclick="handleSubmit()">Submit</button>
</form> 

This is just an example, you are free to use any language you like to send the data across.

To Submit a Document to an Existing Lead

You will need to send the following multipart form-data to https://webleads.abinitiosoftware.co.uk/api/Upload

Postman Example

An example of sending a file via Postman using the Lead number and credentials

Return Status Codes

The status codes returned from the API are the standard HTTP status codes. For example:-