Referência da API

Colunas do pipeline

As colunas do pipeline são as etapas do seu quadro de Conversas, como Interessados ou Call agendada. Cada conversa fica em uma coluna. Solicitações, Caixa de entrada, Contatados, Responderam e as colunas de persona são do próprio quadro, as outras são suas. Um quadro tem no máximo 50 colunas.

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

O objeto pipeline column

Uma coluna do quadro de Conversas, como Interessados ou Call agendada. Cada conversa fica em uma coluna.

Atributos

idstring
Identificador único da coluna.
objectstring
Sempre pipeline_column.
namestring
O nome da coluna.
kindstring
requests, inbox, contacted e replied são as colunas do próprio quadro, persona acompanha uma persona, custom é uma das suas.
requestsinboxcontactedrepliedpersonacustom
persona_idstring ou null
A persona de uma coluna persona.
positioninteger
A posição dela no quadro, a partir de 0 à esquerda.
collapsedboolean
Indica se ela está recolhida no quadro.
deletableboolean
Indica se você pode excluí-la. Só as colunas custom podem ser excluídas.

O objeto pipeline column

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

Listar colunas do pipeline

GET/v1/pipeline_columnsScope readMCPlist_pipeline_columns

Retorna as colunas do quadro, da esquerda para a direita.

Retorno

Uma lista de objetos pipeline column.

GET/v1/pipeline_columns

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

Resposta200

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

Criar uma coluna do pipeline

POST/v1/pipeline_columnsScope writeMCPedit_pipeline_columns

Adiciona uma coluna ao quadro.

Parâmetros do corpo

namestringObrigatório
O nome da coluna, com até 60 caracteres.
positioninteger
Onde ela entra, 0 para a primeira posição. O padrão é a última.

Retorno

As colunas do quadro, uma lista de objetos pipeline column.

Erros

400parameter_missing
Falta um parâmetro obrigatório. param diz qual.
400parameter_invalid
Um parâmetro tem um valor que a API não aceita. param diz qual.
400limit_reached
O quadro já tem 50 colunas.

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

Resposta200

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

Atualizar uma coluna do pipeline

PATCH/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Renomeia uma coluna ou a recolhe no quadro.

Parâmetros de caminho

column_idstringObrigatório
O ID da coluna.

Parâmetros do corpo

namestring
O nome da coluna, com até 60 caracteres.
collapsedboolean
Recolhe a coluna no quadro.

Retorno

As colunas do quadro, uma lista de objetos pipeline column.

Erros

404resource_missing
Nenhuma coluna com este ID na conta da chave.
400parameter_invalid
Um parâmetro tem um valor que a API não aceita. param diz qual.
400parameter_unknown
O corpo tem um campo que este endpoint não aceita.

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

Resposta200

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

Excluir uma coluna do pipeline

DELETE/v1/pipeline_columns/:column_idScope writeMCPedit_pipeline_columns

Exclui uma das suas próprias colunas. As conversas dela voltam para a coluna Caixa de entrada.

Parâmetros de caminho

column_idstringObrigatório
O ID da coluna.

Retorno

Um objeto com o id da coluna e deleted igual a true.

Erros

404resource_missing
Nenhuma coluna com este ID na conta da chave.
400column_protected
A coluna é do próprio quadro, como a Caixa de entrada ou uma coluna 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"

Resposta200

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

Reordenar colunas do pipeline

POST/v1/pipeline_columns/reorderScope writeMCPedit_pipeline_columns

Coloca as colunas do quadro numa nova ordem. Envie cada coluna uma vez.

Parâmetros do corpo

column_idsarray de stringsObrigatório
Todos os IDs de coluna do quadro, da esquerda para a direita.

Retorno

As colunas do quadro na nova ordem, uma lista de objetos pipeline column.

Erros

400parameter_missing
Falta um parâmetro obrigatório. param diz qual.
400parameter_invalid
Um parâmetro tem um valor que a API não aceita. param diz qual.
404resource_missing
Um ID não é de nenhuma coluna do quadro.

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

Resposta200

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