post https://example.com/organization/v1/organizations
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:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| emailConfirmationLandingPage | String | true | Landing page that will be sent in confirmation mail |
| _name | JSON | true | An object that contains first name and last name |
| _description | String | false | |
| _headquarters.countryCode | String | false | A 2-letter country code defined in ISO-3166 |
| _headquarters.state | String | false | |
| _headquarters.city | String | false | |
| _headquarters.zipCode | String | false | |
| _headquarters.address1 | String | false | |
| _headquarters.address2 | String | false | |
| _phone | String | false | An E.164 formatted phone number |
| _timezone | String | false | A java time zone supported by the java runtime environment |
| _locale | String | false | |
| _primaryAdministrator._name.firstName | String | true | |
| _primaryAdministrator._name.lastName | String | true | |
| _primaryAdministrator._description | String | false | |
| _primaryAdministrator._email | String | true | An email address in the RFC-5322 specification |
| _primaryAdministrator._phone | String | false | An E.164 formatted phone number |
| _primaryAdministrator._locale | String | false | |
| _primaryAdministrator._gender | String | false | Supported values are: MALE, FEMALE, UNDISCLOSED |
| _primaryAdministrator._dateOfBirth | LocalDate | false | A UTC date in the ISO-8601 format |
| _primaryAdministrator._address.countryCode | String | false | A 2-letter country code defined in ISO-3166 |
| _primaryAdministrator._address.state | String | false | |
| _primaryAdministrator._address.city | String | false | |
| _primaryAdministrator._address.zipCode | String | false | |
| _primaryAdministrator._address.address1 | String | false | |
| _primaryAdministrator._address.address2 | String | false | |
| _primaryAdministrator._mfa.enabled | Boolean | false | An object that contains expiration in minutes and if enabled |
| _primaryAdministrator._mfa.expirationInMinutes | Integer | false | |
| _templateId | UUID | true | The id of a Organization template that is configured in the settings service. |
| <customAttributes1> | <customAttributes1Type> | false | Custom attribute 1 value |
| <customAttributesN> | <customAttributesNType> | false | Custom attribute N value |
This API requires ORGANIZATION_CREATE_ORGANIZATION permission(s).