Sign in
Groups

Update group

Updates a group's name or description. Requires ownership.

patch/groups/{groupId}

Request body

namestring
descriptionstring nullable

Response

Group updated successfully.

idstring ulid required
ownerstring ulid required
namestring required
descriptionstring nullable
type'domain' | 'list' required
domainstring fqdn

Present if type is 'domain'.

membersstring[]

Array of user emails. Present if type is 'list'.

Changes

Changed in 4 of the 14 revisions of this API.23

  • 9aec27988ad31See the full diff
    • ▲

      the domain response's property type/format changed from string/hostname to string/fqdn for status 200

      response-property-type-changed

  • 128cf3db212c2See the full diff
    • ○

      added the optional property domain to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property members to the response with the 200 status

      response-optional-property-added

  • 02015e1343c51See the full diff
    • ○

      endpoint added

      endpoint-added

  • 0d7f3c7509791See the full diff
    • ▲

      api removed without deprecation

      api-removed-without-deprecation

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog