Riferimento API

Colonne della pipeline

Le colonne della pipeline sono le fasi della tua board Conversazioni, come Interessati o Call prenotata. Ogni conversazione si trova in una colonna. Richieste, Posta in arrivo, Contattati, Hanno risposto e le colonne delle buyer persona fanno parte della board, le altre sono tue. Una board contiene al massimo 50 colonne.

Endpoint

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

L'oggetto colonna della pipeline

Una colonna della board Conversazioni, come Interessati o Call prenotata. Ogni conversazione si trova in una colonna.

Attributi

idstring
Identificatore univoco della colonna.
objectstring
Sempre pipeline_column.
namestring
Il nome della colonna.
kindstring
requests, inbox, contacted e replied sono le colonne proprie della board, persona segue una buyer persona, custom è una delle tue.
requestsinboxcontactedrepliedpersonacustom
persona_idstring o null
La buyer persona di una colonna persona.
positioninteger
La sua posizione sulla board, da 0 a sinistra.
collapsedboolean
Se è compressa sulla board.
deletableboolean
Se puoi eliminarla. Solo le colonne custom si possono eliminare.

L'oggetto colonna della pipeline

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

Elenca le colonne della pipeline

GET/v1/pipeline_columnsScope readMCPlist_pipeline_columns

Restituisce le colonne della board, da sinistra a destra.

Restituisce

Un elenco di oggetti colonna della pipeline.

GET/v1/pipeline_columns

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

Risposta200

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

Crea una colonna della pipeline

POST/v1/pipeline_columnsScope writeMCPedit_pipeline_columns

Aggiunge una colonna alla board.

Parametri del body

namestringObbligatorio
Il nome della colonna, fino a 60 caratteri.
positioninteger
Dove va, 0 per la prima. Di default l'ultima.

Restituisce

Le colonne della board, un elenco di oggetti colonna della pipeline.

Errori

400parameter_missing
Manca un parametro obbligatorio. param lo indica.
400parameter_invalid
Un parametro ha un valore che l'API non accetta. param lo indica.
400limit_reached
La board ha già 50 colonne.

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

Risposta200

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

Aggiorna una colonna della pipeline

PATCH/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Rinomina una colonna, oppure la comprime sulla board.

Parametri di percorso

column_idstringObbligatorio
L'ID della colonna.

Parametri del body

namestring
Il nome della colonna, fino a 60 caratteri.
collapsedboolean
Comprime la colonna sulla board.

Restituisce

Le colonne della board, un elenco di oggetti colonna della pipeline.

Errori

404resource_missing
Nessuna colonna con questo ID sull'account della chiave.
400parameter_invalid
Un parametro ha un valore che l'API non accetta. param lo indica.
400parameter_unknown
Il body ha un campo che questo endpoint non accetta.

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

Risposta200

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

Elimina una colonna della pipeline

DELETE/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Elimina una delle tue colonne. Le sue conversazioni tornano nella colonna Posta in arrivo.

Parametri di percorso

column_idstringObbligatorio
L'ID della colonna.

Restituisce

Un oggetto con l'id della colonna e deleted impostato su true.

Errori

404resource_missing
Nessuna colonna con questo ID sull'account della chiave.
400column_protected
La colonna fa parte della board, come Posta in arrivo o la colonna di una buyer persona.

DELETE/v1/pipeline_columns/:column_id

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

Risposta200

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

Riordina le colonne della pipeline

POST/v1/pipeline_columns/reorderScope writeMCPedit_pipeline_columns

Mette le colonne della board in un nuovo ordine. Invia ogni colonna una volta.

Parametri del body

column_idsarray di stringsObbligatorio
Tutti gli ID colonna della board, da sinistra a destra.

Restituisce

Le colonne della board nel nuovo ordine, un elenco di oggetti colonna della pipeline.

Errori

400parameter_missing
Manca un parametro obbligatorio. param lo indica.
400parameter_invalid
Un parametro ha un valore che l'API non accetta. param lo indica.
404resource_missing
Un ID non corrisponde a nessuna colonna della board.

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

Risposta200

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