Skip to main content

Delete a user group

Delete a user group. DELETE /api/openapi/v1/user-groups/{groupId}, scope admin.v1.user-groups.manage.

  • Scope: admin.v1.user-groups.manage
  • Permission: Manage user groups (user-groups)
  • Permission type: Manage
  • Endpoint: DELETE/api/openapi/v1/user-groups/{groupId}

Authentication and request headers

Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
NameLocationTypeRequiredDescriptionExample
AuthorizationheaderstringYesApplication API key, passed as a Bearer token.Bearer qwk_***
X-Request-IdheaderstringNoOptional request tracing identifier; generated by the server if omitted.req-20260831-001

Request parameters

NameLocationTypeRequiredDescriptionExample
groupIdpathstring · uuidRequiredUser group ID"<uuid>"

Request example

cURL

Responses

204 No Content default Flat business error
NameTypeRequiredDescriptionExample
codestringNoStable business error code"<string>"
detailstringYesHuman-readable error description"<string>"
detailsOpenapiErrorDetailsNoError details{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstringNoRequest field that failed validation"<string>"
details.reasonstringNoStable validation failure reason"<string>"
details.suggestionstringNoSuggested normalized value"<string>"
errorstringYesStable HTTP error type"<string>"
Response example