OrganizationUserGroups

Update an organization user group

Changed on

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}

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/organizations/{organizationId}/user-groups/{id}
  • Auth
    HTTP bearer

Path parameters

organizationIdstring required
idstring required

Unique identifier for the organization user group.

Request body

namestring nullable

Name of the user group.

Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

descriptionstring nullable

Description for the user group.

Any printable characters and line breaks. Cannot contain control characters other than tab, carriage return and line feed, nor invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
descriptionstring required

Changes

    • breaking

      added the pattern ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$ to the request property

    • breaking

      added the pattern ^(?!\s)(?![\s\S]*\s$)(?:[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]|[\t\n\r])+$ to the request property

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • info

      the request property became nullable

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status