Leads aanmaken

Overzicht

Met de Flixer API kun je leads rechtstreeks vanaf je website naar Flixer sturen. Een lead kan bevatten:

Klantgegevens - Contactinformatie van de klant (verplicht)
Opdrachtgegevens - Beschrijving van de gewenste werkzaamheden (verplicht)
Adresgegevens - Waar de klus uitgevoerd moet worden (optioneel)

Adresgegevens zijn optioneel. Zo kun je ook leads aanmaken die alleen naam/e-mail/telefoon bevatten, zoals bij Meta/Facebook Lead Ads en de CSV-import. Er wordt alleen een adres aangemaakt wanneer street, postalCode én city allemaal zijn meegegeven; een gedeeltelijk adres wordt genegeerd.

Endpoint

POST https://api.flixerpro.io/v1/api/leads

Vereiste scope: leads:write

Request velden

Adres (optioneel)

Het volledige adres is optioneel. Wil je een adres koppelen, geef dan street, postalCode én city samen mee — anders wordt het adres genegeerd en krijgt de lead addressId: null.

Veld	Type	Verplicht	Voorbeeld
`street`	string	Voorwaardelijk¹	`"Keizersgracht"`
`streetNumber`	string	Nee	`"123"`
`streetNumberAddition`	string	Nee	`"A"`
`postalCode`	string	Voorwaardelijk¹	`"1015 CJ"`
`city`	string	Voorwaardelijk¹	`"Amsterdam"`
`country`	string	Nee	`"Nederland"`

¹ Alleen verplicht als je een adres wilt aanmaken: street, postalCode en city zijn alle drie nodig of geen van alle.

Klant (verplicht)

Veld	Type	Verplicht	Voorbeeld
`customerName`	string	Ja	`"Jan de Vries"`
`firstName`	string	Nee	`"Jan"`
`lastName`	string	Nee	`"de Vries"`
`email`	string	Nee	`"[email protected]"`
`phone`	string	Nee	`"+31612345678"`
`companyName`	string	Nee	`"De Vries B.V."`

Als companyName is ingevuld, wordt de klant als zakelijke klant geregistreerd.

Opdracht (verplicht)

Veld	Type	Verplicht	Voorbeeld
`title`	string	Ja	`"Lekkage badkamer"`
`description`	string	Nee	`"Waterdruppels op het plafond"`
`category`	string	Nee	`"Loodgieter"`
`priority`	enum	Nee	`"medium"`
`budgetQuote`	string	Nee	`"€500 - €1000"`
`notes`	string	Nee	`"Graag snel contact"`

Priority waarden: low, medium, high, urgent (standaard: medium)

Lead zonder adres

Heb je alleen naam/e-mail/telefoon (zoals bij Meta/Facebook Lead Ads of een CSV-import)? Laat de adresvelden dan gewoon weg. De lead wordt aangemaakt met addressId: null.

cURL

curl -X POST "https://api.flixerpro.io/v1/api/leads" \
  -H "X-API-Key: jouw_api_sleutel" \
  -H "Content-Type: application/json" \
  -d '{
    "customerName": "Jan de Vries",
    "email": "[email protected]",
    "phone": "+31612345678",
    "title": "Lekkage badkamer"
  }'

Volledig voorbeeld

curl -X POST "https://api.flixerpro.io/v1/api/leads" \
  -H "X-API-Key: jouw_api_sleutel" \
  -H "Content-Type: application/json" \
  -d '{
    "street": "Keizersgracht",
    "streetNumber": "123",
    "streetNumberAddition": "A",
    "postalCode": "1015 CJ",
    "city": "Amsterdam",
    "country": "Nederland",
    "customerName": "Jan de Vries",
    "firstName": "Jan",
    "lastName": "de Vries",
    "email": "[email protected]",
    "phone": "+31612345678",
    "title": "Lekkage badkamer",
    "description": "Klant meldt waterschade aan het plafond in de badkamer. Vermoedelijk komt het van de bovenverdieping.",
    "category": "Loodgieter",
    "priority": "high",
    "budgetQuote": "€500 - €1000",
    "notes": "Graag zo snel mogelijk contact opnemen"
  }'

async function createLead(formData) {
  const response = await fetch("https://api.flixerpro.io/v1/api/leads", {
    method: "POST",
    headers: {
      "X-API-Key": process.env.FLIXER_API_KEY,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      // Adres
      street: formData.street,
      streetNumber: formData.streetNumber,
      postalCode: formData.postalCode,
      city: formData.city,
      // Klant
      customerName: `${formData.firstName} ${formData.lastName}`,
      firstName: formData.firstName,
      lastName: formData.lastName,
      email: formData.email,
      phone: formData.phone,
      // Opdracht
      title: formData.subject,
      description: formData.message,
      category: formData.category
    })
  });

  if (!response.ok) {
    throw new Error(`API error: ${response.status}`);
  }

  return response.json();
}

import requests
import os

def create_lead(form_data):
    response = requests.post(
        "https://api.flixerpro.io/v1/api/leads",
        headers={
            "X-API-Key": os.environ["FLIXER_API_KEY"],
            "Content-Type": "application/json"
        },
        json={
            # Adres
            "street": form_data["street"],
            "streetNumber": form_data["street_number"],
            "postalCode": form_data["postal_code"],
            "city": form_data["city"],
            # Klant
            "customerName": f"{form_data['first_name']} {form_data['last_name']}",
            "firstName": form_data["first_name"],
            "lastName": form_data["last_name"],
            "email": form_data["email"],
            "phone": form_data["phone"],
            # Opdracht
            "title": form_data["subject"],
            "description": form_data["message"],
            "category": form_data.get("category")
        }
    )

    response.raise_for_status()
    return response.json()

Response

Bij succes ontvang je de aangemaakte lead:

{
  "id": "WKIabc123def456ghi789",
  "brandId": "BRDabc123...",
  "customerId": "CUSabc123...",
  "addressId": "ADRabc123...",
  "title": "Lekkage badkamer",
  "description": "Klant meldt waterschade aan het plafond...",
  "status": "request",
  "priority": "high",
  "source": "web",
  "receivedAt": "2026-03-27T10:30:00.000Z",
  "createdAt": "2026-03-27T10:30:00.000Z"
}

De response bevat het volledige work item-object. Naast de bovenstaande velden worden ook velden als category, budgetQuote, notes, estimatedCost, finalCost, tags, scheduledStart/scheduledEnd, updatedAt, createdBy en updatedBy teruggegeven (leeg/null als ze niet van toepassing zijn). Is er geen (volledig) adres meegegeven, dan is addressId null.

Bewaar het id van de aangemaakte lead als je later de status wilt opvragen.

Foutafhandeling

HTTP Status	Betekenis
`201 Created`	Lead succesvol aangemaakt
`400 Bad Request`	Validatiefout — een verplicht veld (`customerName`, `title`) ontbreekt of een waarde voldoet niet aan de regels
`401 Unauthorized`	API-sleutel ontbreekt of is ongeldig
`403 Forbidden`	Sleutel heeft niet de `leads:write` scope

De request wordt server-side gevalideerd. Ontbrekende verplichte velden (customerName, title) of ongeldige waarden worden afgewezen met een 400 Bad Request; het message-veld in de response beschrijft wat er misging.

async function createLeadWithErrorHandling(formData) {
  try {
    const response = await fetch("https://api.flixerpro.io/v1/api/leads", {
      method: "POST",
      headers: {
        "X-API-Key": process.env.FLIXER_API_KEY,
        "Content-Type": "application/json"
      },
      body: JSON.stringify(formData)
    });

    if (response.status === 401) {
      console.error("Ongeldige API-sleutel");
      return { success: false, error: "auth_error" };
    }

    if (response.status === 403) {
      console.error("Sleutel mist de leads:write scope");
      return { success: false, error: "scope_error" };
    }

    if (response.status === 400) {
      const body = await response.json();
      console.error("Validatiefout:", body.message);
      return { success: false, error: "validation_error" };
    }

    if (!response.ok) {
      console.error("Onverwachte fout:", response.status);
      return { success: false, error: "server_error" };
    }

    const lead = await response.json();
    return { success: true, lead };
  } catch (error) {
    console.error("Netwerkfout:", error);
    return { success: false, error: "network_error" };
  }
}

Zie Foutafhandeling voor alle foutcodes.

Aan de slag

Handleidingen

Referentie

Overzicht

Endpoint

Request velden

Adres (optioneel)

Klant (verplicht)

Opdracht (verplicht)

Lead zonder adres

Volledig voorbeeld

Response

Foutafhandeling

​Overzicht

​Endpoint

​Request velden

​Adres (optioneel)

​Klant (verplicht)

​Opdracht (verplicht)

​Lead zonder adres

​Volledig voorbeeld

​Response

​Foutafhandeling

Overzicht

Endpoint

Request velden

Adres (optioneel)

Klant (verplicht)

Opdracht (verplicht)

Lead zonder adres

Volledig voorbeeld

Response

Foutafhandeling