CRcryptlex
Organizations

Update an organization

Changed on

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

patch/v3/organizations/{id}

Request

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

Path parameters

idstring required

Unique identifier for the organization.

Request body

namestring nullable

Name of the organization.

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.

emailstring email nullable

Notification email of the organization.

descriptionstring nullable

Description for the organization.

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.

allowedUsersinteger nullable

Max number of users the organization is allowed to create. Set to -1 to allow unlimited users.

resellerIdstring nullable

Unique identifier for the reseller.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
organizationAliasstring nullable
namestring required
emailstring required
descriptionstring required
allowedUsersinteger required
resellerIdstring nullable

Changes

  • 0088bcd57a3cRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

  • 66dcb6293180Revision 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

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status