API-referentie

Pipelinekolommen

Pipelinekolommen zijn de fases van je gesprekkenbord, zoals Geïnteresseerd of Call ingepland. Elk gesprek staat in één kolom. Verzoeken, Inbox, Gecontacteerd, Beantwoord en de personakolommen horen bij het bord, de rest is van jou. Een bord heeft maximaal 50 kolommen.

Endpoints

GET/v1/pipeline_columns
POST/v1/pipeline_columns
PATCH/v1/pipeline_columns/:column_id
DELETE/v1/pipeline_columns/:column_id
POST/v1/pipeline_columns/reorder

Het pipelinekolom-object

Een kolom van het gesprekkenbord, zoals Geïnteresseerd of Call ingepland. Elk gesprek staat in één kolom.

Attributen

idstring
Unieke ID van de kolom.
objectstring
Altijd pipeline_column.
namestring
De naam van de kolom.
kindstring
requests, inbox, contacted en replied zijn de vaste kolommen van het bord, persona hoort bij een persona, custom is een kolom van jou.
requestsinboxcontactedrepliedpersonacustom
persona_idstring of null
De persona van een persona-kolom.
positioninteger
De plek op het bord, vanaf 0 links.
collapsedboolean
Of de kolom op het bord is ingeklapt.
deletableboolean
Of je de kolom kunt verwijderen. Alleen custom-kolommen kunnen worden verwijderd.

Het pipelinekolom-object

{
  "id": "q7m2xk4p",
  "object": "pipeline_column",
  "name": "Interested",
  "kind": "custom",
  "persona_id": null,
  "position": 2,
  "collapsed": false,
  "deletable": true
}

Pipelinekolommen opvragen

GET/v1/pipeline_columnsScope readMCPlist_pipeline_columns

Geeft de kolommen van het bord terug, van links naar rechts.

Resultaat

Een lijst van pipelinekolom-objecten.

GET/v1/pipeline_columns

curl https://gemlead.ai/api/v1/pipeline_columns \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

Response200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Call booked",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Een pipelinekolom maken

POST/v1/pipeline_columnsScope writeMCPedit_pipeline_columns

Voegt een kolom toe aan het bord.

Bodyparameters

namestringVerplicht
De naam van de kolom, maximaal 60 tekens.
positioninteger
Waar de kolom komt, 0 voor de eerste plek. Standaard als laatste.

Resultaat

De kolommen van het bord, een lijst van pipelinekolom-objecten.

Fouten

400parameter_missing
Er ontbreekt een verplichte parameter. param geeft aan welke.
400parameter_invalid
Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
400limit_reached
Het bord heeft al 50 kolommen.

POST/v1/pipeline_columns

curl -X POST https://gemlead.ai/api/v1/pipeline_columns \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Call booked",
    "position": 3
  }'

Response200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Call booked",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Een pipelinekolom bijwerken

PATCH/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Hernoemt een kolom, of klapt hem in op het bord.

Padparameters

column_idstringVerplicht
De ID van de kolom.

Bodyparameters

namestring
De naam van de kolom, maximaal 60 tekens.
collapsedboolean
Klap de kolom in op het bord.

Resultaat

De kolommen van het bord, een lijst van pipelinekolom-objecten.

Fouten

404resource_missing
Geen kolom met deze ID op het account van de sleutel.
400parameter_invalid
Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
400parameter_unknown
De body bevat een veld dat dit endpoint niet accepteert.

PATCH/v1/pipeline_columns/:column_id

curl -X PATCH \
  https://gemlead.ai/api/v1/pipeline_columns/z3c6lf8a \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Demo booked"
  }'

Response200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Demo booked",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Een pipelinekolom verwijderen

DELETE/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Verwijdert een van je eigen kolommen. De gesprekken erin gaan terug naar de kolom Inbox.

Padparameters

column_idstringVerplicht
De ID van de kolom.

Resultaat

Een object met de id van de kolom en deleted op true.

Fouten

404resource_missing
Geen kolom met deze ID op het account van de sleutel.
400column_protected
De kolom hoort bij het bord, zoals Inbox of een personakolom.

DELETE/v1/pipeline_columns/:column_id

curl -X DELETE \
  https://gemlead.ai/api/v1/pipeline_columns/z3c6lf8a \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

Response200

{
  "id": "z3c6lf8a",
  "object": "pipeline_column",
  "deleted": true
}

Volgorde van pipelinekolommen wijzigen

POST/v1/pipeline_columns/reorderScope writeMCPedit_pipeline_columns

Zet de kolommen van het bord in een nieuwe volgorde. Stuur elke kolom één keer.

Bodyparameters

column_idsarray van stringsVerplicht
Alle kolom-ID's van het bord, van links naar rechts.

Resultaat

De kolommen van het bord in de nieuwe volgorde, een lijst van pipelinekolom-objecten.

Fouten

400parameter_missing
Er ontbreekt een verplichte parameter. param geeft aan welke.
400parameter_invalid
Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
404resource_missing
Een ID hoort niet bij een kolom van het bord.

POST/v1/pipeline_columns/reorder

curl -X POST \
  https://gemlead.ai/api/v1/pipeline_columns/reorder \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "column_ids": ["r1n8vd2c", "h5t0bw9e", "z3c6lf8a", "q7m2xk4p"]
  }'

Response200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Call booked",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}