Integrate with PipeIQ
Route Emergency Trade Leads
Directly Into Our Platform

Step 1

Authentication

All API requests must include your API key as a custom header. Your key is unique to your integration and must be kept confidential — do not expose it in client-side code.

To get your API key, complete the form at the bottom of this page — we verify your company against Companies House, then issue your key once your application is approved.

Step 2

Endpoint

There is a single endpoint for lead registration. All requests must use HTTPS and include the Content-Type: application/json header.

POST https://app.pipeiq.co.uk/api/leads/register
Content-Type: application/json
X-PipeIQ-Token: YOUR_API_KEY

Step 3

Request Body

Send a JSON body with the following fields. Only mobile_number and postcode are required.

Step 4

Response Codes

All responses return JSON with a success boolean and a message string. On success, the response also includes the matched postcode sector.

• 201 Created
  Lead registered — welcome SMS dispatched. Response: {"success": true, "message": "...", "sector": "SW1A"}
• 400 Bad Request
  Missing or invalid fields — check that mobile_number and postcode are present and correctly formatted.
• 401 Unauthorized
  Invalid or missing API key — ensure your X-PipeIQ-Token header is correct.
• 422 Unprocessable
  Number previously opted out — this mobile has unsubscribed and cannot receive further messages. Do not retry.
• 500 Server Error
  Unexpected error — contact support@pipeiq.co.uk with your request ID if this persists.

Step 5

Code Examples

Copy either example below and replace YOUR_API_KEY with your assigned key.

curl -X POST https://app.pipeiq.co.uk/api/leads/register \
  -H "Content-Type: application/json" \
  -H "X-PipeIQ-Token: YOUR_API_KEY" \
  -d '{"mobile_number":"07700900000","postcode":"SW1A 1AA","selected_trade":"plumbing","utm_source":"meta"}'

const response = await fetch('https://app.pipeiq.co.uk/api/leads/register', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-PipeIQ-Token': 'YOUR_API_KEY'
  },
  body: JSON.stringify({
    mobile_number: '07700900000',
    postcode: 'SW1A 1AA',
    selected_trade: 'plumbing',
    utm_source: 'meta'
  })
});

const data = await response.json();
// { success: true, message: '...', sector: 'SW1A' }

In Practice

One API call — screened, sent, logged

POST to /api/v1/send and PipeIQ checks the number against TPS/CTPS and your opt-out list, then sends the SMS — typically within a few seconds. Need to message a batch? /api/v1/send-bulk takes up to 500 recipients in one call.

curl -X POST https://app.pipeiq.co.uk/api/v1/send \
  -H "X-PipeIQ-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+447700900100",
    "message": "Hi Patricia, your emergency water claim has been received. We will be in touch shortly. Reply STOP to opt out.",
    "sender_id": "HomeSure"
  }'

const res = await fetch('https://app.pipeiq.co.uk/api/v1/send', {
  method: 'POST',
  headers: {
    'X-PipeIQ-Token': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    to: '+447700900100',
    message: 'Hi Patricia, your emergency water claim has been received. We will be in touch shortly. Reply STOP to opt out.',
    sender_id: 'HomeSure'
  })
});
const data = await res.json();
// { success: true, message_sid: '...', tps_result: { screened: true, registered: false, ctps_registered: false }, status: 'sent', credits_remaining: 214 }

Integration Patterns

Who Integrates with PipeIQ

The partner API is designed for any platform that captures homeowner contact details and wants to reach them by SMS — screened against TPS/CTPS and opt-out lists first — the moment a lead comes in.