User Groups

Edit user group

Updates user group details

patch/api/user-groups/v1/{user_group_id}

Request

Base URL
https://example.piwik.pro
Auth
OAuth 2
Client credentials
Token URL/auth/token
TypeScript
https://skmtc.dev/piwik/apis/web-api/docs/api/user-groups/v1/:user_group_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

user_group_idstring uuid required

UUIDv4 identifier of given user group

Request body

Example request

{
  "data": {
    "id": "9a67f188-734c-4ba3-8769-912a7e59f3ff",
    "attributes": {
      "name": "Managers",
      "external_id": "external group id"
    }
  }
}

Response

No Content

Changes

No recorded changes to this operation across all 2 revisions of this API.