Referencia de la API

Columnas del pipeline

Las columnas del pipeline son las etapas de tu tablero de Conversaciones, como Interesados o Llamada agendada. Cada conversación está en una columna. Solicitudes, Bandeja de entrada, Contactados, Respondieron y las columnas de buyer persona son del propio tablero, las demás son tuyas. Un tablero tiene 50 columnas como máximo.

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

El objeto pipeline column

Una columna del tablero de Conversaciones, como Interesados o Llamada agendada. Cada conversación está en una columna.

Atributos

idstring
Identificador único de la columna.
objectstring
Siempre pipeline_column.
namestring
El nombre de la columna.
kindstring
requests, inbox, contacted y replied son las columnas propias del tablero, persona sigue a un buyer persona, custom es una de las tuyas.
requestsinboxcontactedrepliedpersonacustom
persona_idstring o null
El buyer persona de una columna persona.
positioninteger
Su posición en el tablero, desde 0 a la izquierda.
collapsedboolean
Si está contraída en el tablero.
deletableboolean
Si puedes eliminarla. Solo se pueden eliminar las columnas custom.

El objeto pipeline column

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

Listar columnas del pipeline

GET/v1/pipeline_columnsScope readMCPlist_pipeline_columns

Devuelve las columnas del tablero, de izquierda a derecha.

Devuelve

Una lista de objetos pipeline column.

GET/v1/pipeline_columns

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

Respuesta200

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

Crear una columna del pipeline

POST/v1/pipeline_columnsScope writeMCPedit_pipeline_columns

Añade una columna al tablero.

Parámetros del cuerpo

namestringObligatorio
El nombre de la columna, hasta 60 caracteres.
positioninteger
Dónde va, 0 para la primera posición. Por defecto, la última.

Devuelve

Las columnas del tablero, una lista de objetos pipeline column.

Errores

400parameter_missing
Falta un parámetro obligatorio. param lo indica.
400parameter_invalid
Un parámetro tiene un valor que la API no acepta. param lo indica.
400limit_reached
El tablero ya tiene 50 columnas.

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

Respuesta200

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

Actualizar una columna del pipeline

PATCH/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Renombra una columna o la contrae en el tablero.

Parámetros de ruta

column_idstringObligatorio
El ID de la columna.

Parámetros del cuerpo

namestring
El nombre de la columna, hasta 60 caracteres.
collapsedboolean
Contraer la columna en el tablero.

Devuelve

Las columnas del tablero, una lista de objetos pipeline column.

Errores

404resource_missing
No hay ninguna columna con este ID en la cuenta de la clave.
400parameter_invalid
Un parámetro tiene un valor que la API no acepta. param lo indica.
400parameter_unknown
El cuerpo tiene un campo que este endpoint no acepta.

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

Respuesta200

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

Eliminar una columna del pipeline

DELETE/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Elimina una de tus propias columnas. Sus conversaciones vuelven a la columna Bandeja de entrada.

Parámetros de ruta

column_idstringObligatorio
El ID de la columna.

Devuelve

Un objeto con el id de la columna y deleted en true.

Errores

404resource_missing
No hay ninguna columna con este ID en la cuenta de la clave.
400column_protected
La columna es del propio tablero, como Bandeja de entrada o una columna de 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"

Respuesta200

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

Reordenar las columnas del pipeline

POST/v1/pipeline_columns/reorderScope writeMCPedit_pipeline_columns

Pone las columnas del tablero en un nuevo orden. Envía cada columna una sola vez.

Parámetros del cuerpo

column_idsarray de stringsObligatorio
Todos los ID de columna del tablero, de izquierda a derecha.

Devuelve

Las columnas del tablero en el nuevo orden, una lista de objetos pipeline column.

Errores

400parameter_missing
Falta un parámetro obligatorio. param lo indica.
400parameter_invalid
Un parámetro tiene un valor que la API no acepta. param lo indica.
404resource_missing
Un ID no corresponde a ninguna columna del tablero.

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

Respuesta200

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