# Update group details or dissolve group

This method is used to update the group details. This method can also be used to dissolve a group.

Endpoint: PATCH /group/{{groupId}} - HM
Version: 3.0.0
Security: 

## Request fields (application/json):

  - `updatedBy` (string, required)
    Enter the ID of the group owner who wishes to update the group details.
    Example: "b.sa70@gmail.com"

  - `groupName` (string)
    Enter the name of the group which you want to create.
    Example: "Loyalty Circle"

  - `groupStatus` (string)
    Enter whether the group is currently ACTIVE, INACTIVE or DELETED.
    Example: "ACTIVE"

  - `deleteGroup` (string)
    Enter YES if you want to delete the group.
    Example: "YES"

  - `groupConfigurations` (object)
    If the Enable Group Level Permission option is enabled at the site level, it displays the following group level configuration set by the group owner.

  - `groupConfigurations.allowAutoTransferPointsToGroup` (string)
    Enter YES, If you want to automatically transfer members' points to the group. If you enter NO, the member will have the choice to transfer their points manually to the group.
    Example: "YES"

  - `groupConfigurations.allowGroupPointsRedemption` (string)
    The group owner has the authority to set a rule for redeeming group points. There are only two options- 1. If the owner selects OWNER, only the group owner is eligible to redeem group points. 2. If the owner selects ALL, all the group members are eligible to redeem group points. Enter OWNER or ALL, based on the authority you want to give to redeem group points.
    Example: "OWNER"

## Response 201 fields (application/json):

  - `siteId` (string)
    Displays the Annex Cloud site ID for the loyalty program.
    Example: "29235480"

  - `groupId` (string)
    Displays the unique group ID generated during group creation.
    Example: "91"

  - `groupName` (string)
    Displays the name of the group for which you updated the details.
    Example: "Loyalty Circle"

  - `groupStatus` (string)
    Displays whether the group is currently ACTIVE or INACTIVE.
    Example: "ACTIVE"

  - `updatedBy` (string)
    Displays the ID of the group owner who updated the group details.
    Example: "b.sa70@gmail.com"

  - `groupConfigurations` (object)
    Displays the following values of the configurations you have passed in the request body.

  - `groupConfigurations.allowAutoTransferPointsToGroup` (string)
    Displays whether the value you entered in the request body is YES or NO.
    Example: "NO"

  - `groupConfigurations.allowGroupPointsRedemption` (string)
    Displays the value you entered in the request body for this flag as OWNER or ALL. The group owner has the authority to set a rule for redeeming group points. There are only two options- 1. If the owner selects OWNER, only the group owner is eligible to redeem group points. 2. If the owner selects ALL, all the group members are eligible to redeem group points.
    Example: "OWNER"