Navigation

Rename a Team

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

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Syntax

PATCH /orgs/{ORG-ID}/teams/{TEAM-ID}

Request Path Parameters

Path Element Required/Optional Description
ORG-ID Required The unique identifier for the organization associated with the team that you want to rename.
TEAM-ID Required The unique identifier of the team 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

Path Element Required/Optional Description
name Required The new name of the team.

Response

Name Type Description
id string The unique identifier for the team.
links object array One or more links to sub-resources and/or related resources. The relation-types between URLs are explained in the Web Linking Specification.
name string The new name of the team.

Example

Request

curl  -X PATCH --header "Content-Type: application/json" --include --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest /
 "https://cloud.mongodb.com/api/tlas/v1.0/orgs/6001f2c580eef55aedbc6bb1/teams/6b720e1087d9d66b272f1c86?pretty=true" /
 --data '{"name":"Engineering"}'

Response

{
  "id" : "6b720e1087d9d66b272f1c86",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5991f2c580eef55aedbc6aa0/teams/6b720e1087d9d66b272f1c86",
    "rel" : "self"
  } ],
  "name" : "Engineering"
}