• API >
• Public API Resources >
• Organizations and Teams >
• Organizations >
• Update One Organization Invitation by Invitation ID

Update One Organization Invitation by Invitation ID

Updates one pending invitation by {INVITATION-ID} to the Cloud Manager organization that you specify.

Use the Get All Organization Invitations endpoint to retrieve IDs for all pending organization invitations.

Required Roles

You can successfully call this endpoint with the Organization User Admin role.

Resource

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

copy

PATCH /orgs/{ORG-ID}/invites/{INVITATION-ID}

Request Path Parameters

Path Element	Type	Necessity	Description
ORG-ID	string	Required	Unique 24-hexadecimal digit string that identifies the organization.
INVITATION-ID	string	Required	Unique 24-hexadecimal digit string that identifies the invitation.

Request Query Parameters

The following query parameters are optional:

Name	Type	Necessity	Description	Default
pretty	boolean	Optional	Flag indicating whether the response body should be in a prettyprint format.	false
envelope	boolean	Optional	Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes: Name Description status HTTP response code envelope Expected response body	false

Request Body Parameters

Body Parameter	Type	Necessity	Description
roles	array of strings	Required	Cloud Manager roles to assign to the invited user. If the user accepts the invitation, Cloud Manager assigns these roles to them. Important Cloud Manager replaces the roles in the invitation with those that you provide in this request. Ensure that you include all roles that you want to assign the user in this request.

Response

Name	Type	Description
createdAt	string	Timestamp in ISO 8601 date and time format in UTC when Cloud Manager sent the invitation.
expiresAt	string	Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Tip Users have 30 days to accept an invitation to an Cloud Manager project.
id	string	Unique 24-hexadecimal digit string that identifies the invitation.
inviterUsername	string	Cloud Manager user who invited username to the organization.
orgId	string	Unique 24-hexadecimal digit string that identifies the organization.
orgName	string	Name of the organization.
roles	array of strings	Cloud Manager roles to assign to the invited user. If the user accepts the invitation, Cloud Manager assigns these roles to them.
teamIds	array of strings	Unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
username	string	Email address to which Cloud Manager sent the invitation. If the user accepts the invitation, they use this email address as their Cloud Manager username.

Example Request

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true" \
     --data '
       {
         "roles": [
           "ORG_OWNER"
         ]
       }'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

{
  "createdAt": "2021-02-18T21:05:40Z",
  "expiresAt": "2021-03-20T21:05:40Z",
  "id": "{INVITATION-ID}",
  "inviterUsername": "admin@example.com",
  "orgId": "{ORG-ID}",
  "orgName": "{ORG-NAME}",
  "roles": [
    "ORG_OWNER"
  ],
  "teamIds": [],
  "username": "wyatt.smith@example.com"
}

←   Get One Organization Invitation Update One Organization Invitation  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.