Update an organization user group

Updates the specified organization user group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/organizations/{organizationId}/user-groups/{id}

JWT

organization:userGroup:update

Parameters

Name	Type	In	Description
organizationId*	string	path
id*	string	path	Unique identifier for the organization user group.

Request Body Schema

Property	Type	Description	Constraints
name	string	Name of the user group.	min: 1, max: 256
description	string	Description for the user group.	min: 0, max: 256

Request Example

{
  "name": "string",
  "description": "string"
}

Triggers webhook: organization.userGroup.updated

POST <your-webhook-url>
{
  "event": "organization.userGroup.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "description": "string"
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string"
}