Référence API

Colonnes du pipeline

Les colonnes du pipeline sont les étapes de ton tableau des conversations, comme Intéressés ou Call réservé. Chaque conversation se trouve dans une colonne. Demandes, Inbox, Contactés, Ont répondu et les colonnes de persona font partie du tableau, les autres sont à toi. Un tableau contient 50 colonnes au plus.

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

L'objet colonne du pipeline

Une colonne du tableau des conversations, comme Intéressés ou Call réservé. Chaque conversation se trouve dans une colonne.

Attributs

idstring
Identifiant unique de la colonne.
objectstring
Toujours pipeline_column.
namestring
Le nom de la colonne.
kindstring
requests, inbox, contacted et replied sont les colonnes propres au tableau, persona suit un persona, custom est l'une des tiennes.
requestsinboxcontactedrepliedpersonacustom
persona_idstring ou null
Le persona d'une colonne persona.
positioninteger
Sa place dans le tableau, à partir de 0 à gauche.
collapsedboolean
Si elle est repliée dans le tableau.
deletableboolean
Si tu peux la supprimer. Seules les colonnes custom peuvent l'être.

L'objet colonne du pipeline

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

Lister les colonnes du pipeline

GET/v1/pipeline_columnsScope readMCPlist_pipeline_columns

Renvoie les colonnes du tableau, de gauche à droite.

Renvoie

Une liste d'objets colonne du pipeline.

GET/v1/pipeline_columns

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

Réponse200

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

Créer une colonne du pipeline

POST/v1/pipeline_columnsScope writeMCPedit_pipeline_columns

Ajoute une colonne au tableau.

Paramètres du corps

namestringObligatoire
Le nom de la colonne, 60 caractères au plus.
positioninteger
Sa position, 0 pour la première. En dernier par défaut.

Renvoie

Les colonnes du tableau, une liste d'objets colonne du pipeline.

Erreurs

400parameter_missing
Il manque un paramètre obligatoire. param indique lequel.
400parameter_invalid
Un paramètre a une valeur que l'API n'accepte pas. param indique lequel.
400limit_reached
Le tableau a déjà 50 colonnes.

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

Réponse200

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

Modifier une colonne du pipeline

PATCH/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Renomme une colonne, ou la replie dans le tableau.

Paramètres de chemin

column_idstringObligatoire
L'ID de la colonne.

Paramètres du corps

namestring
Le nom de la colonne, 60 caractères au plus.
collapsedboolean
Replier la colonne dans le tableau.

Renvoie

Les colonnes du tableau, une liste d'objets colonne du pipeline.

Erreurs

404resource_missing
Aucune colonne avec cet ID sur le compte de la clé.
400parameter_invalid
Un paramètre a une valeur que l'API n'accepte pas. param indique lequel.
400parameter_unknown
Le corps contient un champ que cet endpoint n'accepte pas.

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

Réponse200

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

Supprimer une colonne du pipeline

DELETE/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Supprime une de tes colonnes. Ses conversations retournent dans la colonne Inbox.

Paramètres de chemin

column_idstringObligatoire
L'ID de la colonne.

Renvoie

Un objet avec l'id de la colonne et deleted à true.

Erreurs

404resource_missing
Aucune colonne avec cet ID sur le compte de la clé.
400column_protected
La colonne fait partie du tableau, comme Inbox ou une colonne de persona.

DELETE/v1/pipeline_columns/:column_id

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

Réponse200

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

Réordonner les colonnes du pipeline

POST/v1/pipeline_columns/reorderScope writeMCPedit_pipeline_columns

Range les colonnes du tableau dans un nouvel ordre. Envoie chaque colonne une seule fois.

Paramètres du corps

column_idstableau de stringsObligatoire
Tous les ID de colonne du tableau, de gauche à droite.

Renvoie

Les colonnes du tableau dans le nouvel ordre, une liste d'objets colonne du pipeline.

Erreurs

400parameter_missing
Il manque un paramètre obligatoire. param indique lequel.
400parameter_invalid
Un paramètre a une valeur que l'API n'accepte pas. param indique lequel.
404resource_missing
Un ID ne correspond à aucune colonne du tableau.

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

Réponse200

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