Create a new Organization by Template name

post

https://organization/v1/organizations/templates/{templateName}

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:

Parameter	Type	Mandatory	Description	Example
<customAttribute1>	<customAttribute1Type>	false	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	false	Regular custom attribute N value
_description	string	false	A description, can be up to 5000 characters long	Lorem Ipsum
_headquarters	object	false
_headquarters.address1	string	false	An address	11 Main St.
_headquarters.address2	string	false	An address's specifics	Entry B, Apartment 1
_headquarters.city	string	false	A city	Boston
_headquarters.countryCode	string	true(*)	A 2-letter country code defined in ISO-3166	US
_headquarters.state	string	false	A state	Massachusetts
_headquarters.zipCode	string	false	A zipcode	02101
_locale	string	false	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_name	string	true	An organization's name	Example Inc.
_phone	string	false	An E.164 formatted phone number	+12345678901
_primaryAdministrator	object	true
_primaryAdministrator._address	object	false
_primaryAdministrator._address.address1	string	false	An address	11 Main St.
_primaryAdministrator._address.address2	string	false	An address's specifics	Entry B, Apartment 1
_primaryAdministrator._address.city	string	false	A city	Boston
_primaryAdministrator._address.countryCode	string	true(*)	A 2-letter country code defined in ISO-3166	US
_primaryAdministrator._address.state	string	false	A state	Massachusetts
_primaryAdministrator._address.zipCode	string	false	A zipcode	02101
_primaryAdministrator._credentialType	string	false	What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP
_primaryAdministrator._dateOfBirth	string	false	A person's date of birth A UTC date in the ISO-8601 format	2007-12-20
_primaryAdministrator._description	string	false	A description, can be up to 5000 characters long	Lorem Ipsum
_primaryAdministrator._email	string	false	An email address in the RFC-5322 specification	[email protected]
_primaryAdministrator._employeeId	string	false
_primaryAdministrator._gender	string	false	A persons gender Values:MALE,FEMALE,UNDISCLOSED	FEMALE
_primaryAdministrator._locale	string	false	A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_primaryAdministrator._mfa	object	false
_primaryAdministrator._mfa.enabled	boolean	true(*)	MFA login enabled or disabled
_primaryAdministrator._mfa.expirationInMinutes	integer	false	MFA expiration time in minutes
_primaryAdministrator._name	object	true(*)
_primaryAdministrator._name.firstName	string	true(*)	A person's first name	John
_primaryAdministrator._name.lastName	string	true(*)	A person's last name	Smith
_primaryAdministrator._phone	string	false	A person's phone An E.164 formatted phone number	+12345678901
_timezone	string	false	A java time zone supported by the java runtime environment	Europe/Oslo
Path Parameters:

Parameter	Type	Mandatory	Description	Example
templateName	string	true	null
Query Parameters:

Parameter	Type	Mandatory	Description	Example
includeReferencers	boolean	false	Optional query parameter that controls whether the response should include referencers metadata. When set to true, the response will contain an additional `_referencers` JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.). If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments. Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

This API requires ORGANIZATION_CREATE_ORGANIZATION permission(s).

Path Params

templateName

string

required

Query Params

includeReferencers

boolean

Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

Body Params

_name

string

required

length between 1 and 32

An organization's name

_description

string

A description, can be up to 5000 characters long

_headquarters

object

_phone

string

An E.164 formatted phone number

_timezone

string

A java time zone supported by the java runtime environment

_locale

string

Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

_primaryAdministrator

object

required

Headers

x-execution-mode

string

enum

Defaults to async

X-Execution-Mode — Optional header to control execution mode.

Use sync to make the API wait until all background operations complete before returning a response.

If omitted, the request is processed asynchronously (default).

Allowed:

Responses

Parameter	Type	Description	Example
<customAttribute1>	<customAttribute1Type>	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	Regular custom attribute N value
_caption	string
_creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_description	string	A description, can be up to 5000 characters long	Lorem Ipsum
_headquarters	object
_headquarters.address1	string	An address	11 Main St.
_headquarters.address2	string	An address's specifics	Entry B, Apartment 1
_headquarters.city	string	A city	Boston
_headquarters.countryCode	string	A 2-letter country code defined in ISO-3166	US
_headquarters.state	string	A state	Massachusetts
_headquarters.zipCode	string	A zipcode	02101
_id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_locale	string	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_name	string	An organization's name	Example Inc.
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_ownerOrganization.template	object
_ownerOrganization.template.displayName	string	The display name of the template
_ownerOrganization.template.id	string	The id of the template
_ownerOrganization.template.name	string	The name of the template
_ownerOrganization.template.parentTemplate	object
_ownerOrganization.template.parentTemplate.displayName	string
_ownerOrganization.template.parentTemplate.id	string
_ownerOrganization.template.parentTemplate.name	string
_ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.templateName	string	The name of the referenced entity template
_phone	string	An E.164 formatted phone number	+12345678901
_primaryAdministrator	object
_primaryAdministrator.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_primaryAdministrator.name	string	The caption of the referenced entity
_primaryAdministrator.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_primaryAdministrator.parentEntityId	string	The id of the parent entity (appears only for child entities)
_primaryAdministrator.template	object
_primaryAdministrator.template.displayName	string	The display name of the template
_primaryAdministrator.template.id	string	The id of the template
_primaryAdministrator.template.name	string	The name of the template
_primaryAdministrator.template.parentTemplate	object
_primaryAdministrator.template.parentTemplate.displayName	string
_primaryAdministrator.template.parentTemplate.id	string
_primaryAdministrator.template.parentTemplate.name	string
_primaryAdministrator.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_primaryAdministrator.templateName	string	The name of the referenced entity template
_referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
_template	object
_template.displayName	string	The display name of the template
_template.id	string	The id of the template
_template.name	string	The name of the template
_template.parentTemplate	object
_template.parentTemplate.displayName	string
_template.parentTemplate.id	string
_template.parentTemplate.name	string
_timezone	string	A java time zone supported by the java runtime environment	Europe/Oslo

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Code : TOKEN_NOT_VALID, Details: []

404Code : TEMPLATE_NOT_FOUND_BY_NAME, Details: [templateName] Code : REFERENCE_CONFIGURATION_ENTITY_NOT_FOUND, Details: [attributeName, entityId]

409Code : ORGANIZATION_ALREADY_EXIST, Details: [name] Code : EMAIL_ALREADY_EXIST, Details: [email]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []