Create a Domain

This API allows authorized users to create a new domain. The domain creation process requires specific data to be provided in the request body. Only users with the necessary permissions can successfully create a domain.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Headers

Authorization: Bearer [Token]

Body:

KeyDescriptionRequired
nameThe Name of the Domain to be CreatedYes
enabledIndicates Whether the Domain is Enabled/Disabled (True/False)Yes
descriptionA Brief Description of the DomainYes
typeThe Type of the Domain (Direct/Resale)Yes
languageThe Default Language for the Domain (en-us / fr-ca)Yes
timezoneThe Time-zone Associated with the DomainYes
parent_uuidThe Unique Identifier of the Parent DomainNo
partner_idThe Unique Identifier of the PartnerNo
Body Params
uuid | null

UUID of the parent domain. Can be null.

string
required

Name of the domain.

boolean
required

Whether the domain is enabled.

string
required

Description of the domain.

string
enum
required

Type of domain, either Direct or Resale.

Allowed:
uuid | null

UUID of the partner, can be null.

string
enum
required

Language setting for the domain.

Allowed:
string
required

Timezone setting for the domain.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json