Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Stage → Update

AI-generated

Summary

Update stage name and order weight

Inputs

  • authentication — Authentication method to use for the API request. Defaults to API Key if not specified. OAuth2 is also available for token-based access.
  • id (required) — ID of the stage to update. Choose from the list, or specify an ID. Supports two modes: By ID (numeric ID matching regex [0-9]+) or From list (searchable list via getStages).
  • name — Name of the stage. Optional; if provided, the stage's name will be updated.
  • orderWeight — Set this value to enforce a specific sort order for the stage. Defaults to 1000 if not specified.

Output shape

The operation returns the updated stage object reflecting the changes to name and/or orderWeight, or confirmation of the update. Exact return shape depends on API response.

Both name and orderWeight are optional; providing neither still performs an update but may not produce visible changes.

Examples

Example 1: Update a stage name by ID using API Key authentication

authentication: apiKey; id (By ID): 42; name: 'New Stage Name'

Example 2: Update stage sort order from a saved list

authentication: apiKey; id (From list): selected stage; orderWeight: 50

Links

Discussion