Update One Organization

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

Copy endpoint

https://cloud.mongodb.com

Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

Parameters

path Path Parameters

Name	Type
`orgId` required 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.	string

query Query Parameters

Name	Type
`envelope` 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.	boolean
`pretty` Flag that indicates whether the response body should be in the prettyprint format.	boolean

Request Body

application/vnd.atlas.2023-01-01+json required

Details to update on the specified organization.

interface AtlasOrganization {
id?: string;
isDeleted?: boolean;
links?: readonly

Link

interface Link {
href?: string;
rel?: string;
}

[];
name: string;
skipDefaultAlertsSettings?: boolean;
}

Responses

200 application/vnd.atlas.2023-01-01+json

interface AtlasOrganization {
id?: string;
isDeleted?: boolean;
links?: readonly

Link

interface Link {
href?: string;
rel?: string;
}

[];
name: string;
skipDefaultAlertsSettings?: boolean;
}

Client Errors

400 application/json

Bad Request.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

401 application/json

Unauthorized.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

403 application/json

Forbidden.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

404 application/json

Not Found.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

409 application/json

Conflict.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

Server Errors

500 application/json

Internal Server Error.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}