Submit Lead

https://api.swiftswitch.co.uk/v1/leads/create

Notes

Each successfully submitted Lead will return a reference number which must be provided when raising self-bills for referral fees.

Headers

Your unique API key must be included in the header of each request.

Header	Type	Required
x-api-key	string	required

Body

application/json

Available keys when submitting a new Lead.

Field	Type	Required
Last_Name	string	required
First_Name	string	required
Company	string	optional
Product	string	optional
Email	string	optional
Phone	string	required
Postal_Code	string	optional
Street	string	optional
Description	string	optional

Responses

Success — Lead Submitted

application/json

Field	Type
Lead_Id	string
Description	string

Sample requests

A collection of sample requests in popular languages.

JavaScript / Axios

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://api.swiftswitch.co.uk/v1/leads/create',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json'
  },
  data: {
    Last_Name: 'Bennett',
    First_Name: 'Roger',
    Company: 'Roger Cleaning Co.',
    Product: 'Water',
    Email: 'roger@example.com',
    Phone: '020 8111 1111',
    Postal_Code: 'T3 5ST',
    Street: '1 Pretend Street',
    Description: 'Lorem ipsum dolor et al.\nSed ut perspiciatis unde omnis.'
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Example response

application/json

201

{
  "Lead_Id": "ss_183493000008555003",
  "Description": "Lead Accepted"
}

PreviousAuthentication NextSupport