v1

latestOpenAPI 3.0.0Apache 2.02026-07-17263751.6 KB
Groups

update

Rename a group

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

put/v1/group/{groupId}

Path parameters

groupIdinteger required

The groupId of the group to update.

Request body

newNamestring required

The new name of the group being renamed.

Example request

{
  "newName": "your_group_name"
}

Response

Successful update of group

Example response

{
  "group": {
    "buckets": [
      {
        "created": "2023-10-03T08:59:39.312Z",
        "fileSize": "3.1GB",
        "updated": "2023-10-03T08:59:39.312Z"
      }
    ],
    "created": "2023-10-03T08:59:39.312Z",
    "fileSize": "3.1GB",
    "updated": "2023-10-03T08:59:39.312Z"
  }
}