Gå til indhold

Læg leads i en pipeline

Via API’et kan jeres eget system oprette pipelines i ownr Pipeline, lægge virksomheder ind som leads og flytte dem mellem stadier.

Kræver: scopet pipeline. Kald til Pipeline tæller ikke i API-kvoten.

1. Tjek leadkapaciteten

Leadkapaciteten gælder hele virksomheden: alle pipelines trækker på den samme pulje. Leads, der kommer fra et købt segment, tæller ikke med.

Terminal window
curl "https://ownr.dk/api/v2/pipelines/capacity" \
-H "Authorization: Bearer ACCESS_TOKEN"

available i svaret er antallet af leads, der er plads til.

2. Opret en pipeline

Terminal window
curl -X POST "https://ownr.dk/api/v2/pipelines" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Egne kunder Q4","entity_type":"company"}'
  • entity_type er company, person eller property og kan ikke ændres bagefter.
  • Uden stages får pipelinen standardsættet på 8 stadier. Med stages angiver I navnene på jeres egne stadier, som lægges ind mellem de tre faste: Nye leads, Vundet og Tabt.
  • At oprette en pipeline bruger ingen kapacitet. Det gør kun leads.

Svaret indeholder pipelinens id og id’et for hvert stadie.

3. Tilføj leads

Leads tilføjes som CVR-numre, op til 10.000 pr. kald:

Terminal window
curl -X POST "https://ownr.dk/api/v2/pipelines/189/leads" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"cvr":[36732261,24256790,31183146]}'
  • Kaldet er alt eller intet: er der ikke plads til hele partiet, tilføjes ingen, og svaret er 402 med det præcise antal, der mangler.
  • Send "partial": true for at tilføje så mange, der er plads til.
  • Leads, der allerede er i pipelinen, springes over og tælles i skipped_duplicates. Ugyldige CVR-numre står i invalid_cvr.
  • stage vælger stadiet. Uden det lander leads i det første stadie.

4. Flyt et lead

Terminal window
curl -X PATCH "https://ownr.dk/api/v2/pipelines/189/leads/90311" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"stage":1231}'

Flytningen virker som at trække kortet i ownr: den logges, og teammedlemmer, der følger stadiet, får besked. Flyttes et lead til Vundet, og er automatisk tilføjelse til Ajour slået til, lægges det også i Ajour.

5. Ryd op

  • DELETE /pipelines/{pipelineId}/leads/{leadId} fjerner et lead og frigiver dets kapacitet med det samme.
  • DELETE /pipelines/{pipelineId} sletter en pipeline og frigiver kapaciteten for dens leads. At arkivere en pipeline frigiver ikke kapacitet.

Alle Pipeline-endpoints står i referencen.