Create a new Organization

Create a new Organization

Organization admin will be created and set as the admin for the created organization.

Confirmation email with provided landing page will be sent.

Custom attributes can be specified in the request body

The below table describes the request parameters:

ParameterTypeMandatoryDescription
emailConfirmationLandingPageStringtrueLanding page that will be sent in confirmation mail
_nameJSONtrueAn object that contains first name and last name
_descriptionStringfalse
_headquarters.countryCodeStringfalseA 2-letter country code defined in ISO-3166
_headquarters.stateStringfalse
_headquarters.cityStringfalse
_headquarters.zipCodeStringfalse
_headquarters.address1Stringfalse
_headquarters.address2Stringfalse
_phoneStringfalseAn E.164 formatted phone number
_timezoneStringfalseA java time zone supported by the java runtime environment
_localeStringfalse
_primaryAdministrator._name.firstNameStringtrue
_primaryAdministrator._name.lastNameStringtrue
_primaryAdministrator._descriptionStringfalse
_primaryAdministrator._emailStringtrueAn email address in the RFC-5322 specification
_primaryAdministrator._phoneStringfalseAn E.164 formatted phone number
_primaryAdministrator._localeStringfalse
_primaryAdministrator._genderStringfalseSupported values are: MALE, FEMALE, UNDISCLOSED
_primaryAdministrator._dateOfBirthLocalDatefalseA UTC date in the ISO-8601 format
_primaryAdministrator._address.countryCodeStringfalseA 2-letter country code defined in ISO-3166
_primaryAdministrator._address.stateStringfalse
_primaryAdministrator._address.cityStringfalse
_primaryAdministrator._address.zipCodeStringfalse
_primaryAdministrator._address.address1Stringfalse
_primaryAdministrator._address.address2Stringfalse
_primaryAdministrator._mfa.enabledBooleanfalseAn object that contains expiration in minutes and if enabled
_primaryAdministrator._mfa.expirationInMinutesIntegerfalse
_templateIdUUIDtrueThe id of a Organization template that is configured in the settings service.
<customAttributes1><customAttributes1Type>falseCustom attribute 1 value
<customAttributesN><customAttributesNType>falseCustom attribute N value

This API requires ORGANIZATION_CREATE_ORGANIZATION permission(s).

Language
Authentication
Bearer
JWT
Click Try It! to start a request and see the response here!