API-Referenz

Pipeline-Spalten

Pipeline-Spalten sind die Phasen im Board deiner Unterhaltungen, etwa Interessiert oder Call gebucht. Jede Unterhaltung liegt in genau einer Spalte. Anfragen, Posteingang, Kontaktiert, Geantwortet und die Persona-Spalten gehören zum Board, die anderen legst du selbst an. Ein Board hat höchstens 50 Spalten.

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

Das Pipeline-Spaltenobjekt

Eine Spalte im Board der Unterhaltungen, etwa Interessiert oder Call gebucht. Jede Unterhaltung liegt in genau einer Spalte.

Attribute

idstring
Eindeutige Kennung der Spalte.
objectstring
Immer pipeline_column.
namestring
Der Name der Spalte.
kindstring
requests, inbox, contacted und replied sind die festen Spalten des Boards, persona gehört zu einer Persona, custom ist eine von deinen.
requestsinboxcontactedrepliedpersonacustom
persona_idstring oder null
Die Persona einer persona-Spalte.
positioninteger
Ihre Position im Board, ab 0 ganz links.
collapsedboolean
Ob sie im Board eingeklappt ist.
deletableboolean
Ob du sie löschen kannst. Nur custom-Spalten lassen sich entfernen.

Das Pipeline-Spaltenobjekt

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

Pipeline-Spalten auflisten

GET/v1/pipeline_columnsScope readMCPlist_pipeline_columns

Gibt die Spalten des Boards zurück, von links nach rechts.

Rückgabe

Eine Liste von Pipeline-Spaltenobjekten.

GET/v1/pipeline_columns

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

Antwort200

{
  "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
}

Pipeline-Spalte erstellen

POST/v1/pipeline_columnsScope writeMCPedit_pipeline_columns

Fügt dem Board eine Spalte hinzu.

Body-Parameter

namestringErforderlich
Der Name der Spalte, bis zu 60 Zeichen.
positioninteger
Ihre Position, 0 für ganz vorne. Standardmäßig ganz hinten.

Rückgabe

Die Spalten des Boards, eine Liste von Pipeline-Spaltenobjekten.

Fehler

400parameter_missing
Ein Pflichtparameter fehlt. param nennt ihn.
400parameter_invalid
Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
400limit_reached
Das Board hat schon 50 Spalten.

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
  }'

Antwort200

{
  "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
}

Pipeline-Spalte ändern

PATCH/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Benennt eine Spalte um oder klappt sie im Board ein.

Pfadparameter

column_idstringErforderlich
Die ID der Spalte.

Body-Parameter

namestring
Der Name der Spalte, bis zu 60 Zeichen.
collapsedboolean
Die Spalte im Board einklappen.

Rückgabe

Die Spalten des Boards, eine Liste von Pipeline-Spaltenobjekten.

Fehler

404resource_missing
Keine Spalte mit dieser ID im Konto des Schlüssels.
400parameter_invalid
Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
400parameter_unknown
Der Body enthält ein Feld, das dieser Endpoint nicht akzeptiert.

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"
  }'

Antwort200

{
  "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
}

Pipeline-Spalte löschen

DELETE/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Löscht eine deiner eigenen Spalten. Ihre Unterhaltungen kommen zurück in die Spalte Posteingang.

Pfadparameter

column_idstringErforderlich
Die ID der Spalte.

Rückgabe

Ein Objekt mit der id der Spalte und dem Wert true in deleted.

Fehler

404resource_missing
Keine Spalte mit dieser ID im Konto des Schlüssels.
400column_protected
Die Spalte gehört zum Board, etwa Posteingang oder eine Persona-Spalte.

DELETE/v1/pipeline_columns/:column_id

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

Antwort200

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

Pipeline-Spalten neu ordnen

POST/v1/pipeline_columns/reorderScope writeMCPedit_pipeline_columns

Bringt die Spalten des Boards in eine neue Reihenfolge. Sende jede Spalte genau einmal.

Body-Parameter

column_idsArray von stringsErforderlich
Alle Spalten-IDs des Boards, von links nach rechts.

Rückgabe

Die Spalten des Boards in der neuen Reihenfolge, eine Liste von Pipeline-Spaltenobjekten.

Fehler

400parameter_missing
Ein Pflichtparameter fehlt. param nennt ihn.
400parameter_invalid
Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
404resource_missing
Eine ID gehört zu keiner Spalte des Boards.

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"]
  }'

Antwort200

{
  "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
}