Replace

Replace document by specified filter or Id.

Replace the entire document with a new one. When you want to update the document, and you don't know which part will be updated each time, you can update that document by replacing it entirely.

[ReplaceOne] - Replace document by specified filter.

Replace the entire document with a new one. When you want to update the document, and you don't know which part will be updated each time, you can update that document by replacing it entirely. https://docs.codemash.io/api/database/collections/replace

put

/{version}/db/{CollectionName}/replaceOne

Authorizations

Path parameters

CollectionNameanyrequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionanyrequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Header parameters

Acceptanyrequired

Accept Header

X-CM-Clusterany

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdanyrequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodeany

Specify culture code when your response from the API should be localised. E.g.: en

Body

application/jsonapplication/x-www-form-urlencoded

any

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.codemash.io//{version}/db/{CollectionName}/replaceOne' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

200

{
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  },
  "result": {
    "isAcknowledged": null,
    "isModifiedCountAvailable": null,
    "matchedCount": null,
    "modifiedCount": null,
    "upsertedId": "text"
  }
}

Success