portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Create Domain
This endpoint allows the creation of a new domain. Ensure you have the necessary permissions before attempting to create a domain. You should have yukiapi:domain:domains:create and yukiapi:domain:domains:write scopes to access this endpoint.
post
https://apirest.yukiworks.com/api/v1/portals/{portal-id}/domains
Path Parameters
Headers
Authorizationstringrequired
Bearer token for authentication
Content-Typestringrequired
Content type, must be application/json
Allowed values:application/json
Body
application/json
Body
application/json
CreateDomain
Schema for creating a new domain.
* Additional properties are NOT allowed.
portalIdstringrequired
The UUID (GUID) of the portal associated with the domain.
Example:550e8400-e29b-41d4-a716-446655440000
namestringrequired
The domain name. If not supplied, will be generated from company name. Only lowercase letters, number and dashes are allowed.
Example:my-company-name
statusstringrequired
The status of the domain for creation purposes.
Allowed values:StartupActive
Example:Active
bundlestringrequired
The bundle type for the domain.
Allowed values:MinimalSmallMediumLargeUnlimited
Example:Medium
languagestringrequired
The locale for the domain.
BE: nl-BE, en-US, fr-BE.
NL: en-US, nl-NL
Allowed values:nl-BEen-USfr-BEnl-NL
Example:en-US
companyobjectrequired
Company information object.
Show Child Parameters
createCustomerUserbooleanrequired
Whether to create a customer user.
Example:true
customerNamestringrequired
The name of the customer.
Example:John Doe
customerEmailstring(email)required
The email address of the customer.
Example:john.doe@yuki.nl
backofficeobjectrequired
Back office configuration settings.
Show Child Parameters
Response
application/json
Response
application/json
Domain successfully created
idstring
The unique identifier of the created domain
Example:3afb7b54-6144-4561-9a29-1148006f2375
application/json