Insert One Document

POST /action/insertOne
Access token Email & Password Api key Custom jwt

Insert a single document into a collection.

Body

  • dataSource string 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.

  • database string Required

    The name of a database in the specified data source.

  • collection string Required

    The name of a collection in the specified database.

  • document object Required

    A document to insert into the collection.

Body

  • dataSource string 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.

  • database string Required

    The name of a database in the specified data source.

  • collection string Required

    The name of a collection in the specified database.

  • document object Required

    A document to insert into the collection.

Responses

  • 200

    Inserted

    Hide response attribute Show response attribute object
    • insertedId

      The _id value of the inserted document.

    Hide response attribute Show response attribute object
    • insertedId

      The _id value of the inserted document.
  • 400 application/json

    The request was malformed or incomplete.

    One of:
    ErrorNoAuthenticationSpecified object ErrorMissingAuthenticationParameter object
  • 401 application/json

    The authenticated user does not have permission to access this endpoint.

    Hide response attributes Show response attributes object

    Indicates that no user matched the provided authentication credentials.

    • error string

      A message that describes the error.

      Value is invalid session: error finding user for endpoint.

    • error_code string

      The error type.

      Value is InvalidSession.

    • link string

      A link to a log entry for the failed operation.
POST /action/insertOne 
curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/insertOne" \
  -X POST \
  -H "apiKey: $API_KEY" \
  -H 'Content-Type: application/ejson' \
  -H "Accept: application/json" \
  -d '{
    "dataSource": "mongodb-atlas",
    "database": "learn-data-api",
    "collection": "tasks",
    "document": {
      "status": "open",
      "text": "Do the dishes"
    }
  }'
Request example 
{
  "database": "todo",
  "document": {
    "text": "Do the dishes",
    "status": "open${{ env.BUNDLED_SPEC_FILEPATH }}"
  },
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
Request example 
{
  "database": "todo",
  "document": {
    "text": "Do the dishes",
    "status": "open"
  },
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
Response examples (200) 
{
  "insertedId": "6193504e1be4ab27791c8133"
}
Response examples (200) 
{
  "insertedId": {
    "$oid": "6193504e1be4ab27791c8133"
  }
}
Response examples (400) 
{
  "error": "no authentication methods were specified",
  "error_code": "InvalidParameter",
  "link": "string"
}
{
  "error": "must specify some form of authentication (either email+password, api-key, or jwt) in the request header or body",
  "error_code": "MissingParameter",
  "link": "string"
}
Response examples (401) 
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}