Navigation

Rename a Team

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.

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

PATCH /orgs/{ORG-ID}/teams/{TEAM-ID}
Path ElementRequired/OptionalDescription
ORG-IDRequiredThe unique identifier for the organization associated with the team that you want to rename.
TEAM-IDRequiredThe unique identifier of the team that you want to rename.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false
Path ElementRequired/OptionalDescription
nameRequiredThe new name of the team.
NameTypeDescription
idstringThe unique identifier for the team.
linksobject arrayOne or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification.
namestringThe new name of the team.
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"}'
{
"id" : "6b720e1087d9d66b272f1c86",
"links" : [ {
"href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5991f2c580eef55aedbc6aa0/teams/6b720e1087d9d66b272f1c86",
"rel" : "self"
} ],
"name" : "Engineering"
}
Give Feedback