Actions46
- Checklist Actions
- Converter Job Actions
- Document Actions
- Document Label Actions
- Folder Actions
- IFC File Actions
- IFC Search Actions
- Project Actions
- Sync Actions
- Topic Actions
- User Actions
- Workflow Actions
Document Label → Update
AI-generatedSummary
Update a document label in a specified StreamBIM project by modifying fields such as its name and label group, using either structured fields or a raw JSON:API body.
Inputs
- Project Name or ID — Select the StreamBIM project by name or ID to scope the document label update.
- Document Label Name or ID (required) — Select the specific document label to update, identified by its name or ID.
- Use Raw JSON Body — Toggle to update the document label using a full raw JSON:API body instead of individual typed fields.
- Name — Provide a new display name for the document label (used if not using raw JSON body).
- Label Group ID — Optionally specify the ID of the label group to which this label belongs (used if not using raw JSON body).
- Body — Provide a full JSON:API request body to update the document label (used if 'Use Raw JSON Body' is true).
Output shape
a single updated document label record
The operation returns the updated document label object in JSON:API format after applying the changes. Only one document label can be updated per execution. The Project Name or ID is optional as the node allows context from multiple resources, but is recommended to specify the project context.
Examples
Example 1: Update the name and label group of a document label using typed parameters
Set Project Name or ID, select Document Label by ID, provide new Name and optional Label Group ID, leave 'Use Raw JSON Body' unchecked.
Example 2: Update the document label with a custom JSON:API body
Set Project Name or ID, select Document Label by ID, check 'Use Raw JSON Body' and enter the full JSON:API body reflecting desired updates.