Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateMembership

Updates membership configuration.

Request Syntax


PUT /v1/membership/membershipId/update-membership HTTP/1.1
Content-type: application/json

{
   "incidentResponseTeam": [ 
      { 
         "email": "string",
         "jobTitle": "string",
         "name": "string"
      }
   ],
   "membershipAccountsConfigurationsUpdate": { 
      "coverEntireOrganization": boolean,
      "organizationalUnitsToAdd": [ "string" ],
      "organizationalUnitsToRemove": [ "string" ]
   },
   "membershipName": "string",
   "optInFeatures": [ 
      { 
         "featureName": "string",
         "isEnabled": boolean
      }
   ],
   "undoMembershipCancellation": boolean
}

URI Request Parameters

The request uses the following URI parameters.

membershipId

Required element for UpdateMembership to identify the membership to update.

Length Constraints: Minimum length of 12. Maximum length of 34.

Pattern: m-[a-z0-9]{10,32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

incidentResponseTeam

Optional element for UpdateMembership to update the membership name.

Type: Array of IncidentResponder objects

Array Members: Minimum number of 2 items. Maximum number of 10 items.

Required: No

membershipAccountsConfigurationsUpdate

The membershipAccountsConfigurationsUpdate field in the UpdateMembershipRequest structure allows you to update the configuration settings for accounts within a membership.

This field is optional and contains a structure of type MembershipAccountsConfigurationsUpdate that specifies the updated account configurations for the membership.

Type: MembershipAccountsConfigurationsUpdate object

Required: No

membershipName

Optional element for UpdateMembership to update the membership name.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 50.

Required: No

optInFeatures

Optional element for UpdateMembership to enable or disable opt-in features for the service.

Type: Array of OptInFeature objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: No

undoMembershipCancellation

The undoMembershipCancellation parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status.

This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn't been fully terminated yet.

If set to true, the cancellation request will be revoked
If set to false the service will throw a ValidationException.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

message: The ID of the resource which lead to the access denial.

HTTP Status Code: 403

ConflictException

message: The exception message.
resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

message: The exception message.
retryAfterSeconds: The number of seconds after which to retry the request.

HTTP Status Code: 500

InvalidTokenException

message: The exception message.

HTTP Status Code: 423

ResourceNotFoundException

message: The exception message.

HTTP Status Code: 404

SecurityIncidentResponseNotActiveException

message: The exception message.

HTTP Status Code: 400

ServiceQuotaExceededException

message: The exception message.
quotaCode: The code of the quota.
resourceId: The ID of the requested resource which lead to the service quota exception.
resourceType: The type of the requested resource which lead to the service quota exception.
serviceCode: The service code of the quota.

HTTP Status Code: 402

ThrottlingException

message: The exception message.
quotaCode: The quota code of the exception.
retryAfterSeconds: The number of seconds after which to retry the request.
serviceCode: The service code of the exception.

HTTP Status Code: 429

ValidationException

fieldList: The fields which lead to the exception.
message: The exception message.
reason: The reason for the exception.

HTTP Status Code: 400