Sign in
global-groups

update global group description

Changed on
<h3>CS administrator changes the description of the global group.</h3>
patch/global-groups/{group_code}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/global-groups/{group_code}
  • Auth: API key in header Authorization

Request body

descriptionstring text required

group description

Example request

{
  "description": "description"
}

Response

global group modified

codestring text required

group code

descriptionstring text required

group description

created_atstring date-time

object creation time

updated_atstring date-time

last time updated

member_countinteger

member count

Example response

{
  "code": "groupcode",
  "description": "description",
  "created_at": "2022-01-20T00:00:00.001Z",
  "updated_at": "2022-01-22T07:30:00.001Z",
  "member_count": 10
}

Changes

  • 96a0c3f37988Revision changes
    • ▲

      added the pattern ^[a-zA-Z0-9-_,.;:!? ]*$ to the request property

    • ○

      the //// response's property pattern ^[a-zA-Z0-9-_,.;:!? ]*$ was added for the status

  • de7a128e55a7Revision changes
    • ○

      added to the response body allOf list for the response status