Update a Resource Group Membership

Updates a resource group membership, by ID.

Specify the resource group membership ID in the resourceGroupMembershipId URI parameter.

Only the resourceGroupId can be changed with this action. Resource group memberships with a status of "pending" cannot be updated. For more information about resource group memberships, see the Managing Hybrid Services guide.

PUT/v1/resourceGroup/memberships/{resourceGroupMembershipId}
Query Parameters
Name
Description
resourceGroupMembershipId
stringrequired

The unique identifier for the resource group membership.

Body Parameters
Name
Description
resourceGroupId
stringrequired

The resource group ID.

licenseId
stringrequired

The license ID.

personId
stringrequired

The person ID.

personOrgId
stringrequired

The organization ID of the person.

status
enumrequired

The activation status of the resource group membership.

Response Properties
Name
Description
id
string

A unique identifier for the resource group membership.

resourceGroupId
string

The resource group ID.

licenseId
string

The license ID.

personId
string

The person ID.

personOrgId
string

The organization ID of the person.

status
enum

The activation status of the resource group membership.

pending

activation pending

activated

activated

error

error present

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
PUT
/v1/resourceGroup/memberships/
Log in to try the API.
Header
Body
  • The resource group ID.
  • The license ID.
  • The person ID.
  • The organization ID of the person.
  • The activation status of the resource group membership.
Example Response
{
  "id": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
  "resourceGroupId": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
  "licenseId": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
  "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
  "personOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "status": "activated"
}