Skip to main content

Create Pipeline

POST 
/v1/crm/pipeline/create

Creates a pipeline that drives stage calculation for its object type (usually Opportunity). Provide stages in order; stageId should be omitted, it is assigned by the server on create. Each stage needs a name, a filterGroup with at least one filter and a valid filterGroupOperator, and mutations. A stage filterGroup determines membership from the object field values (for opportunities, typically standard__opportunity_status and standard__opportunity_probability, for example status Open with probability greater than 0.2 and at most 0.3). Stages should cover the probability range 0 to 1 with no gaps or overlaps. An object calculated stage is derived by matching its field values against these filters; the stage is never set directly on the object. Stage mutations are applied on stage entry and are required. Changing a pipeline affects stage calculation for every object in it. For opportunity pipelines, standard__opportunity_status is typically Open, Closed Won, or Closed Lost. Stage mutations must reference fields by fieldId, not externalId.

Request​

Responses​

A successful response.