MOmongodb

Update One Document

Changed on

Update a single document in a collection.

post/action/updateOne

Request

  • Base URL
    https://data.mongodb-api.com/app/your-app-id/endpoint/data/v1
  • URL
    https://data.mongodb-api.com/app/your-app-id/endpoint/data/v1/action/updateOne
  • Auth
    • API key in header Authorization
    • or API key in header email and API key in header password
    • or API key in header apiKey
    • or API key in header jwtTokenString

Request body

dataSourcestring required

The name of a linked MongoDB Atlas data source. This is commonly "mongodb-atlas" though it may be different in your App if you chose a different name when you created the data source.

databasestring required

The name of a database in the specified data source.

collectionstring required

The name of a collection in the specified database.

filterobject required

A MongoDB query filter that matches documents. For a list of all query operators that the Data API supports, see Query Operators.

updateobject required

A MongoDB update expression to apply to matching documents. For a list of all update operators that the Data API supports, see Update Operators.

upsertboolean

When true, if the update filter does not match any existing documents, then insert a new document based on the filter and the specified update operation.

Response

Updated

matchedCountnumber required

The number of documents matched by the query filter.

modifiedCountnumber required

The number of matched documents that were modified.

upsertedIdstring

The _id value of the upserted document.

Changes

  • 5088bc79b2f0Revision changes
    • breaking

      the / response's property type changed from number object to no type for status (media type: application/json)

    • breaking

      the / response's property type changed from number object to no type for status (media type: application/ejson)

    • breaking

      the / response's property type changed from number object to no type for status (media type: application/json)

    • breaking

      the / response's property type changed from number object to no type for status (media type: application/ejson)