Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Deal Pipeline → Update

AI-generated

Summary

Update a Follow Up Boss pipeline by ID or selected list entry, optionally modifying its fields and associated stages.

Inputs

  • authentication — Choose authentication method: API Key or OAuth2 (default: API Key).
  • id (required) — Pipeline identifier: provide a numeric ID (validated as [0-9]+), or select from the pipeline list via the resource locator.
  • updateFields — Optional collection of fields to update on the pipeline: description (string), name (string), orderWeight (string for sort order).
  • stages — Optional fixed collection of stage objects (multiple values allowed). Each stage may include: closedStage (boolean), color (hex string), description (string), name (string), orderWeight (string), and id (stage ID). If id is omitted, a new stage is created and associated with the pipeline.

Output shape

The updated pipeline object returned by the Follow Up Boss API, reflecting any changes to fields and associated stages.

Authentication defaults to API Key. The id parameter is required and supports ID-by-string or list-selection modes. Stage id omission creates new stages; inclusion updates existing ones.

Examples

Example 1: Update pipeline name and associate a closed stage

Set id to a valid pipeline ID, updateFields.name to 'New Pipeline Name', and stages[0].closedStage to true with stages[0].id set to the target stage ID.

Example 2: Create a new pipeline with initial stages

Omit stages[].id for each stage to be newly created, provide updateFields.name and updateFields.description, and set stages[].name for each desired stage.

Links

Discussion