Update Stage
Update_Stage updates an existing GovTribe stage and returns the updated stage resource as JSON text.
Input Contract
stage_id: GovTribe ID of the stage to update.type:stringrequired:yesdefault:n/a
name: Updated stage name.type:stringrequired:nodefault:omit to keep current nameshape:min length 1, max length 50
description: Updated stage description text.type:stringrequired:nodefault:omit to keep current descriptionshape:min length 1, max length 1000
index: Updated stage order value.type:integerrequired:nodefault:omit to keep current ordershape:min 0, max 996
pursuit_index_map: Optional pursuit-order payload for reordering pursuits within this stage.type:array<object>required:nodefault:omit to keep current pursuit ordershape:[{ "_id": "<PURSUIT_ID>", "index": <NON_NEGATIVE_INTEGER> }]
Output Contract
Top-level keys:
govtribe_idgovtribe_typegovtribe_urlnamedescriptiontypecreated_atupdated_atownercreatorpipeline
Row keys:
n/a
Relationship retrieval map:
creatorresource_type:usertool:Search_Usersfilter:user_idsnested_keys:govtribe_id,govtribe_type,name,email
ownerresource_type:usertool:Search_Usersfilter:user_idsnested_keys:govtribe_id,govtribe_type,name,email
pipelineresource_type:pipelinetool:Search_Pipelinesfilter:creator_idsnested_keys:govtribe_id,govtribe_type,govtribe_url,name
Usage Patterns
Pattern A: Rename and reposition a stage in the pipeline sequence. Tool: Update_Stage
Pattern B: Update stage description while keeping current order. Tool: Update_Stage
Pattern C: Reorder pursuits inside a stage lane after pipeline review. Tool: Update_Stage
Pattern D: Apply metadata updates and pursuit reordering in one idempotent request. Tool: Update_Stage
Last updated
Was this helpful?
