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 → Update
AI-generatedSummary
Update an existing document in a specified StreamBIM project by modifying its filename, description, folder location, and attached labels, or by providing a full JSON:API body for more detailed changes.
Inputs
- Project Name or ID — Select the StreamBIM project by its name or ID from your account to specify which project the document belongs to.
- Document (required) — Specify the document to update by selecting from a search list, entering its numeric ID, or providing its StreamBIM URL.
- Use Raw JSON Body — Choose whether to update the document by editing the full JSON:API body directly instead of the predefined typed fields.
- Filename — Set the document's filename including extension (e.g., drawing.pdf). Used only if not using raw JSON body.
- Description — Provide or update the document's description text. Used only if not using raw JSON body.
- Folder Name or ID — Select or specify the folder to place the document in within the project. Used only if not using raw JSON body.
- Label Names or IDs — Attach one or multiple labels to the document by selecting or specifying their IDs. Used only if not using raw JSON body.
- Body — Provide the full JSON:API document body to use for the update operation, allowing advanced or custom updates beyond the typed fields.
Output shape
a single record
Returns the updated document record from StreamBIM. The response is a JSON:API resource that includes updated attributes and relationships reflecting the changes made by the update operation.
Examples
Example 1: Update document metadata
A user selects a project and a document by ID, updates the filename, description, moves it to a different folder, and attaches labels, all using typed fields (not raw JSON).
Example 2: Advanced update with raw JSON body
A user provides a complete JSON:API body to update nested or custom document attributes that are not exposed by typed fields.