Organizations

Create an organization

Creates a new organization.

post/v3/organizations

Request body

namestring required

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 required

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 required

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

Created

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

Changes

Changed in 1 of the 2 revisions of this API.23

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

      request-property-pattern-added

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

      request-property-pattern-added

    • added the new optional request property customAttributes

      new-optional-request-property

    • added the required property customAttributes to the response with the 201 status

      response-required-property-added

    • added the required property reseller/customAttributes to the response with the 201 status

      response-required-property-added

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