Add a record to a pipeline

curl --request POST \
  --url https://api.gleap.io/v3/pipelines/{pipelineId}/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'project: <project>' \
  --data '
{
  "recordId": "<string>",
  "laneId": "<string>",
  "values": "<unknown>"
}
'

import requests

url = "https://api.gleap.io/v3/pipelines/{pipelineId}/entries"

payload = {
    "recordId": "<string>",
    "laneId": "<string>",
    "values": "<unknown>"
}
headers = {
    "project": "<project>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    project: '<project>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({recordId: '<string>', laneId: '<string>', values: '<unknown>'})
};

fetch('https://api.gleap.io/v3/pipelines/{pipelineId}/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gleap.io/v3/pipelines/{pipelineId}/entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recordId' => '<string>',
    'laneId' => '<string>',
    'values' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "project: <project>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gleap.io/v3/pipelines/{pipelineId}/entries"

	payload := strings.NewReader("{\n  \"recordId\": \"<string>\",\n  \"laneId\": \"<string>\",\n  \"values\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("project", "<project>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gleap.io/v3/pipelines/{pipelineId}/entries")
  .header("project", "<project>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recordId\": \"<string>\",\n  \"laneId\": \"<string>\",\n  \"values\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gleap.io/v3/pipelines/{pipelineId}/entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recordId\": \"<string>\",\n  \"laneId\": \"<string>\",\n  \"values\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "recordId": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "pipeline": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "values": "<unknown>",
  "_id": "<string>",
  "laneChangedAt": "2023-11-07T05:31:56Z",
  "recordSnapshot": {
    "subtitle": "<string>",
    "plan": "<string>",
    "externalId": "<string>",
    "value": 123,
    "name": "<string>"
  },
  "laneId": "<string>",
  "lexorank": "<string>",
  "createdBy": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  }
}

Pipelines

Add a record to a pipeline

Add a company or contact to a pipeline. recordId is the Gleap id of the record — a company’s _id (see GET /companies) or a contact’s id, matching the pipeline’s recordType. laneId picks the stage and defaults to the pipeline’s first stage; values sets initial field values keyed by fieldId (see GET /pipelines//properties).

A record sits on a pipeline at most once: adding one that is already present returns the existing entry unchanged instead of creating a duplicate. Pipeline automations configured for “record added” run on a genuine add.

POST

pipelines

{pipelineId}

entries

Add a record to a pipeline

curl --request POST \
  --url https://api.gleap.io/v3/pipelines/{pipelineId}/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'project: <project>' \
  --data '
{
  "recordId": "<string>",
  "laneId": "<string>",
  "values": "<unknown>"
}
'

import requests

url = "https://api.gleap.io/v3/pipelines/{pipelineId}/entries"

payload = {
    "recordId": "<string>",
    "laneId": "<string>",
    "values": "<unknown>"
}
headers = {
    "project": "<project>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    project: '<project>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({recordId: '<string>', laneId: '<string>', values: '<unknown>'})
};

fetch('https://api.gleap.io/v3/pipelines/{pipelineId}/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gleap.io/v3/pipelines/{pipelineId}/entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recordId' => '<string>',
    'laneId' => '<string>',
    'values' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "project: <project>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gleap.io/v3/pipelines/{pipelineId}/entries"

	payload := strings.NewReader("{\n  \"recordId\": \"<string>\",\n  \"laneId\": \"<string>\",\n  \"values\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("project", "<project>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gleap.io/v3/pipelines/{pipelineId}/entries")
  .header("project", "<project>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recordId\": \"<string>\",\n  \"laneId\": \"<string>\",\n  \"values\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gleap.io/v3/pipelines/{pipelineId}/entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recordId\": \"<string>\",\n  \"laneId\": \"<string>\",\n  \"values\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "recordId": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "pipeline": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  },
  "values": "<unknown>",
  "_id": "<string>",
  "laneChangedAt": "2023-11-07T05:31:56Z",
  "recordSnapshot": {
    "subtitle": "<string>",
    "plan": "<string>",
    "externalId": "<string>",
    "value": 123,
    "name": "<string>"
  },
  "laneId": "<string>",
  "lexorank": "<string>",
  "createdBy": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project

string

required

Path Parameters

pipelineId

string

required

Body

application/json

recordId

string

required

Gleap id of the record to add, matching the pipeline's recordType: a company's _id (see GET /companies) or a contact's id. Not your own external companyId / userId.

laneId

string

Stage to add the entry to — a lane id from the pipeline's lanes. Defaults to the pipeline's first stage.

values

any

Initial field values, keyed by the pipeline's field fieldIds (see GET /pipelines/{pipelineId}/properties). Primitive values only.

Response

200 - application/json

Generic types for Document:

T - the type of _id
TQueryHelpers - Object with any helpers that should be mixed into the Query type
DocType - the type of the actual Document created

updatedAt

string

required

createdAt

string

required

recordId

object

required

Show child attributes

recordType

enum<string>

required

Available options:

COMPANY,

CONTACT

pipeline

object

required

Show child attributes

project

object

required

Show child attributes

values

any

required

_id

string

required

laneChangedAt

string<date-time>

recordSnapshot

object

Show child attributes

laneId

string

lexorank

string

createdBy

object

Show child attributes

⌘I

Getting Started

Endpoints

Add a record to a pipeline

Authorizations

Headers

Path Parameters

Body

Response