MOmongodb
Organizations

Update One Organization

Updates one organization.

patch/api/atlas/v2/orgs/{orgId}

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

orgIdstring required
Example:4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

idstring

Unique 24-hexadecimal digit string that identifies the organization.

isDeletedboolean

Flag that indicates whether this organization has been deleted.

namestring required

Human-readable label that identifies the organization.

skipDefaultAlertsSettingsboolean

Disables automatic alert creation. When set to true, no organization level alerts will be created automatically.

Example request

{
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.