Luxor Documentation Hub Logo
Mining Pool/API Documentation/Workspaces

Update group

Allows for rename of a group in a workspace.

PATCH
/v1/workspace/groups/{id}

Authorization

authorization<token>

Use your API key here.

In: header

Request Body

application/jsonRequired

Provide the new name for this group.

nameRequiredstring

A group name for which to retrieve summary information.

Minimum length: 1

Path Parameters

idRequiredstring

An alternate shortcut for specifying subaccounts. Can be used in place of subaccount_names

Format: "uuid"
curl -X PATCH "https://app.luxor.tech/api/v1/workspace/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My group"
  }'

Default Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "My group",
  "type": "POOL",
  "url": "/v1/workspace/groups/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "members": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe"
      },
      "status": "ACTIVE",
      "role": "ADMIN"
    }
  ],
  "subaccounts": [
    {
      "id": 0,
      "name": "subaccount_1",
      "created_at": "2019-08-24T14:15:22Z",
      "url": "/v1/pool/groups/3fa85f64-5717-4562-b3fc-2c963f66afa6/subaccounts/subaccount_1"
    }
  ]
}

Previous

Create group

Next

Delete group