CreatePipeline
Create a CRM pipeline: a board of deals that move through stages, such as a sales, renewals, fundraising, hiring or partnership pipeline.
Starter documentation. Features and account details may differ from this deployment.
CreatePipeline
Create a CRM pipeline: a board of deals that move through stages, such as a sales, renewals, fundraising, hiring or partnership pipeline. Each entry tracks a company or a contact, and the pipeline starts with the tracked record, Stage, Owner and Revenue fields; Stage starts with the team's default stages unless stages gives others. Leave out tracks for a generic pipeline: a free-form table of entries that needs no company or contact, starting with only a Name field, plus a Stage field when stages is given. Only when the user asked for a new pipeline: check ListPipelines first so you do not create a duplicate. Returns the pipeline with its id and fields.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The pipeline's name, e.g. "Q4 Renewals". |
tracks | "company" | "contact" | No | "company" for deals with organizations, "contact" for deals with individual people (candidates, investors, partners). Leave out for a generic pipeline whose entries need no company or contact. |
sharedWithTeam | boolean | No | Let the user's team see and edit it. Defaults to false: only the user can see it. |
stages | string[] | No | The stages, first to last, e.g. ["Sourced", "Screen", "Interview", "Offer", "Hired"]. Leave empty for the team's default stages. |
fields | ToolNewField[] | No | Fields to add after Company/Contact, Stage, Owner and Revenue, or after a generic pipeline's Name. |