Cosmos DBInstall

Summary

Add new fields to an existing Cosmos DB document specified by its ID and partition key, using JSON Pointer paths for precise field placement.

Inputs

• Authentication Type (required) — Choose the authentication method for connecting to Cosmos DB, either Master Key or Microsoft Entra ID (Azure AD).
• Database Name or ID (required) — Select or specify the target Cosmos DB database for the item.
• Container Name or ID (required) — Select or specify the target container within the chosen database.
• Item (required) — Specify the ID of the existing item/document to update, either from a list or by entering the ID.
• Partition Key (required) — Provide the partition key value corresponding to the item to ensure correct targeting.
• Fields to Add (required) — Enter one or more key/value pairs to add to the item, using JSON Pointer paths (e.g., /newField) to specify the fields and their values. Values can be JSON or plain text.
• Use Dev Override (Custom Endpoint + Token) — Optional toggle to bypass OAuth by providing a custom endpoint URL and access token, useful for development environments.
• Custom Endpoint — Provide the Cosmos DB account endpoint URL when using the Dev Override option.
• Custom Access Token — Provide a bearer token scoped for Azure Cosmos DB when using the Dev Override option.

Output shape

a list of updated item documents or status objects corresponding to each input item

Each output item corresponds to an input item with added fields. The response includes the updated document or a status object indicating success and HTTP status code. Errors per item are handled according to node settings.

Examples

Example 1: Add fields to an existing document

Set the Authentication Type, select Database and Container, specify the existing Item ID and Partition Key value, and provide fields to add with JSON Pointer paths and values.

Links

• n8n community nodes installation guide