User GuideAPI Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's Free
API Reference

Create a new Organization by Template name

Create a new Organization by Template name

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

Confirmation email with provided landing page will be sent.

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_headquartersobjectfalse
_headquarters.address1stringfalseAn address11 Main St.
_headquarters.address2stringfalseAn address's specificsEntry B, Apartment 1
_headquarters.citystringfalseA cityBoston
_headquarters.countryCodestringtrue(*)A 2-letter country code defined in ISO-3166US
_headquarters.statestringfalseA stateMassachusetts
_headquarters.zipCodestringfalseA zipcode02101
_localestringfalseLocale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.en-us
_namestringtrueAn organization's nameExample Inc.
_phonestringfalseAn E.164 formatted phone number+12345678901
_primaryAdministratorobjecttrue
_primaryAdministrator._addressobjectfalse
_primaryAdministrator._address.address1stringfalseAn address11 Main St.
_primaryAdministrator._address.address2stringfalseAn address's specificsEntry B, Apartment 1
_primaryAdministrator._address.citystringfalseA cityBoston
_primaryAdministrator._address.countryCodestringtrue(*)A 2-letter country code defined in ISO-3166US
_primaryAdministrator._address.statestringfalseA stateMassachusetts
_primaryAdministrator._address.zipCodestringfalseA zipcode02101
_primaryAdministrator._dateOfBirthstringfalseA person's date of birth A UTC date in the ISO-8601 formatThu Dec 20 00:00:00 UTC 2007
_primaryAdministrator._descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_primaryAdministrator._emailstringtrue(*)An email address in the RFC-5322 specification[email protected]
_primaryAdministrator._employeeIdstringtrue(*)
_primaryAdministrator._genderstringfalseA persons gender Values:MALE,FEMALE,UNDISCLOSEDFEMALE
_primaryAdministrator._localestringfalseA person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.en-us
_primaryAdministrator._mfaobjectfalse
_primaryAdministrator._mfa.enabledbooleantrue(*)MFA login enabled or disabled
_primaryAdministrator._mfa.expirationInMinutesintegerfalseMFA expiration time in minutes
_primaryAdministrator._nameobjecttrue(*)
_primaryAdministrator._name.firstNamestringtrue(*)A person's first nameJohn
_primaryAdministrator._name.lastNamestringtrue(*)A person's last nameSmith
_primaryAdministrator._phonestringfalseA person's phone An E.164 formatted phone number+12345678901
_timezonestringfalseA java time zone supported by the java runtime environmentEurope/Oslo

Path Parameters:

ParameterTypeMandatoryDescriptionExample
templateNamestringtruenull

This API requires ORGANIZATION_CREATE_ORGANIZATION permission(s).

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