Rename an Organization

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

Base URL:


PATCH /orgs/{ORG-ID}

Request Path Parameters

Name Type Description
ORG-ID string The id of the organization that you want to rename.

Request Query Parameters

The following query parameters are optional:

Query Parameter Type Description Default
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

Name Type Description
name string The new name for the organization.


Name Type Description
id ObjectId Unique identifier for the organization.
links document array One or more links to sub-resources and/related resources. The relations between URLs are explained in the Web Linking Specification.
name string New name of the organization.


Example Request

curl -X PATCH --include --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --header "Content-Type: application/json" \
     "" \
     --data '{"name":"MyAtlasCluster"}'

Example Response

  "id" : "6001f2c580eef55aedbc6bb1",
  "links" : [ {
    "href" : "",
    "rel" : "self"
  }, {
    "href" : "",
    "rel" : ""
  }, {
    "href" : "",
    "rel" : ""
  }, {
    "href" : "",
    "rel" : ""
  } ],
  "name" : "MyAtlasCluster"