Lead API

Översikt

SeeRM erbjuder öppna API:er för leads så att du kan skapa egna endpoints för tre huvudsakliga syften:

1. Incoming Leads - Skapa nya leads automatiskt
2. Incoming Lead Updates - Uppdatera befintliga leads
3. Outgoing Leads - Hämta leadinformation från SeeRM till externa system

Endast Admins kan skapa, ändra eller uppdatera API:er.
API-hantering görs under Admin → API.

Alla lead-API:er använder samma endpointstruktur:

https://example.seerm.se/api/lead/1752825914353

ID:t i slutet är den API-konfiguration du skapade i SeeRM.

Incoming Leads API

När du skapar ett Incoming Leads API definierar du:

• Ett namn på API:t
• Vilken source som ska sättas på skapade leads
• Vilken type som ska sättas på skapade leads
• Valfri autentisering med ett hemligt värde för Bearer authorization

Du kan också välja om systemet ska:

• Tillåta skapande av lead om kunden redan finns - Skapar leaden på den befintliga kunden
• Blockera skapande av lead om kunden redan finns - Returnerar ett 409-fel

Du kan välja hur kunden ska valideras:

• Email and phonenumber (standard)
• Email only
• Phonenumber only

Fält

• En lista över tillgängliga fält visas när du sätter upp API:t
• Fält markerade med en röd * är obligatoriska
• Du kan byta namn på fälten så att de matchar det externa systemet

Exempel

Exakta fältnamn beror på din mapping, men en typisk payload kan se ut så här:

{
  "name": "Heat Pump - Anna Svensson",
  "customer_name": "Anna Svensson",
  "email": "[email protected]",
  "phonenumber": "46701234567",
  "street": "Storgatan 12",
  "zipcode": "11122",
  "city": "Stockholm",
  "info": "Interested in installation before summer."
}

Incoming Lead Update API

När du skapar ett Incoming Lead Update API definierar du:

• Ett namn på API:t
• Scope för vilka sources eller types som detta API får uppdatera (lämna tomt för att tillåta alla)
• Vilka leadfält API:t får uppdatera
• Valfri autentisering med ett hemligt värde för Bearer authorization

Detta API uppdaterar bara de fält som faktiskt skickas med i requesten.

Fält

• En lista över tillgängliga fält visas i uppsättningen
• Du kan byta namn på fälten så att de matchar det externa systemet

Exempel

Alla fält är valfria vid uppdateringar. Ta bara med de värden du vill ändra.

{
  "name": "Heat Pump - Anna Svensson",
  "priority": "High",
  "status": "Contacted",
  "info": "Customer asked for an updated quote.",
  "closeDate": "2026-04-15"
}

Outgoing Leads API

Outgoing Leads API gör det möjligt att skicka lead-data från SeeRM till externa system.

När du skapar det definierar du:

• Ett namn på API:t
• Autentisering, som är obligatorisk, med ett hemligt värde för Bearer authorization
• Vilka sources och types som ska vara tillgängliga via API:t (lämna tomt för att tillåta alla)
• Vilka värden som ska vara synliga i svaret

Användning av endpoint

Du kan använda endpointen på två sätt:

1. Hämta en specifik lead

   https://example.seerm.se/api/lead/1752825914353?name=<leadname>

2. Hämta flera leads

   https://example.seerm.se/api/lead/1752825914353

Noteringar för flera leads:

Maximalt 100 leads returneras åt gången. Om du får exakt 100 kan det finnas fler. Justera filter eller scope vid behov.

Du kan använda valfria query-parametrar för filtrering och sortering:

fromDate - Startdatum (rekommenderat format: YYYY-MM-DD, till exempel 2026-03-01)

toDate - Slutdatum (samma format som fromDate)

sortField - Fält som ska användas för sortering

sortOrder - asc eller desc

Alla parametrar kan kombineras efter behov.

Exempel

JSON-payloaden beror på vilka värden du väljer att göra synliga när API:t skapas. Fält som inte är aktiverade utelämnas från svaret.

• En lead: svaret ligger i lead: { ... }
• Flera leads: svaret ligger i leads: [ ... ]

Nedan är ett exempel på svar när vanliga leadfält är aktiverade:

{
  "lead": {
    "name": "Heat Pump - Anna Svensson",
    "status": "Qualified",
    "source": "Website",
    "type": "Installation",
    "priority": "High",
    "value": 15000,
    "closeDate": "2026-04-15",
    "info": "Customer wants installation before summer.",
    "customer": {
      "name": "Anna Svensson",
      "email": "[email protected]",
      "number": "46701234567"
    },
    "address": {
      "street": "Storgatan 12",
      "zipcode": "11122",
      "city": "Stockholm",
      "country": "SE"
    }
  }
}