API reference

Pipeline columns

Pipeline columns are the stages of your Conversations board, like Interested or Call booked. Each conversation sits in one column. Requests, Inbox, Contacted, Replied and persona columns belong to the board, the others are yours. A board holds 50 columns at most.

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

The pipeline column object

A column of the Conversations board, like Interested or Call booked. Each conversation sits in one column.

Attributes

idstring
Unique identifier for the column.
objectstring
Always pipeline_column.
namestring
The column's name.
kindstring
requests, inbox, contacted and replied are the board's own columns, persona follows a persona, custom is one of yours.
requestsinboxcontactedrepliedpersonacustom
persona_idstring or null
The persona of a persona column.
positioninteger
Its place on the board, from 0 on the left.
collapsedboolean
Whether it is folded on the board.
deletableboolean
Whether you can delete it. Only custom columns can go.

Pipeline column object

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

List pipeline columns

GET/v1/pipeline_columnsread scopeMCPlist_pipeline_columns

Returns the board's columns, from left to right.

Returns

A list of pipeline column objects.

GET/v1/pipeline_columns

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

Response200

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

Create a pipeline column

POST/v1/pipeline_columnswrite scopeMCPedit_pipeline_columns

Adds a column to the board.

Body parameters

namestringRequired
The column's name, up to 60 characters.
positioninteger
Where it goes, 0 for first. Default last.

Returns

The board's columns, a list of pipeline column objects.

Errors

400parameter_missing
A required parameter is missing. param names it.
400parameter_invalid
A parameter has a value the API does not accept. param names it.
400limit_reached
The board has 50 columns already.

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

Response200

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

Update a pipeline column

PATCH/v1/pipeline_columns/:column_idwrite scopeMCPedit_pipeline_columns

Renames a column, or folds it on the board.

Path parameters

column_idstringRequired
The column's ID.

Body parameters

namestring
The column's name, up to 60 characters.
collapsedboolean
Fold the column on the board.

Returns

The board's columns, a list of pipeline column objects.

Errors

404resource_missing
No column with this ID on the key's account.
400parameter_invalid
A parameter has a value the API does not accept. param names it.
400parameter_unknown
The body has a field this endpoint does not take.

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

Response200

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

Delete a pipeline column

DELETE/v1/pipeline_columns/:column_idwrite scopeMCPedit_pipeline_columns

Deletes one of your own columns. Its conversations go back to the Inbox column.

Path parameters

column_idstringRequired
The column's ID.

Returns

An object with the column's id and deleted set to true.

Errors

404resource_missing
No column with this ID on the key's account.
400column_protected
The column belongs to the board, like Inbox or a persona column.

DELETE/v1/pipeline_columns/:column_id

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

Response200

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

Reorder pipeline columns

POST/v1/pipeline_columns/reorderwrite scopeMCPedit_pipeline_columns

Puts the board's columns in a new order. Send every column once.

Body parameters

column_idsarray of stringsRequired
Every column ID of the board, from left to right.

Returns

The board's columns in the new order, a list of pipeline column objects.

Errors

400parameter_missing
A required parameter is missing. param names it.
400parameter_invalid
A parameter has a value the API does not accept. param names it.
404resource_missing
An ID is not one of the board's columns.

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

Response200

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