Sign in
latestOpenAPI 3.0.02026-08-19307334615.8 KB

17bf8913206e

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/{pipelineId}/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

Path parameters

pipelineIdstring required

Headers

projectstring required

Request body

recordIdstring 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.

laneIdstring

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

{"stackTrail":"components:schemas:PipelineEntryDTO:properties:values","oasType":"schema","type":"unknown","description":"Initial field values, keyed by the pipeline's field `fieldId`s (see\nGET /pipelines/{pipelineId}/properties). Primitive values only."}

Response

Ok

updatedAtstring required
createdAtstring required
laneChangedAtstring date-time
laneIdstring
dueDatestring date-time
lexorankstring
recordType'COMPANY' | 'CONTACT' required
{"stackTrail":"paths:/pipelines/{pipelineId}/entries:post:responses:200:content:application/json:schema:allOf:properties:values","oasType":"schema","type":"unknown"}
_idstring required