Actions148
- Action Plan Actions
- Action Plan Assignment Actions
- Appointment Actions
- Appointment Outcome Actions
- Appointment Type Actions
- Automation Actions
- Automation Assignment Actions
- Call Actions
- Custom Field Actions
- Deal Actions
- Deal Attachment Actions
- Deal Custom Field Actions
- Deal Pipeline Actions
- Email Marketing Campaign Actions
- Email Marketing Event Actions
- Email Template Actions
- Event Actions
- Group Actions
- Identity Actions
- Note Actions
- People Relationship Actions
- Person Actions
- Person Attachment Actions
- Pond Actions
- Reaction Actions
- Smart List Actions
- Stage Actions
- Task Actions
- Team Actions
- Team Inbox Actions
- Text Message Actions
- Text Message Template Actions
- Threaded Reply Actions
- Timeframe Actions
- User Actions
Stage → Update
AI-generatedSummary
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