Create Site

This endpoint is used to create a new site. If the new site was created successfully, then the long Id of the new site will be returned. Note that every newly created site will, by default, have a zone created for it.

Controlled Errors

Error CodeError Message
error_timezone_not_foundNo timezone with Id provided found.
error_user_not_foundThe user creating the site was not found.
error_site_not_createdCreation of site has failed.

Any status codes returned that are not provided here are generic status codes that can be found here.

Body Params
string
required

The name of the site.

string
required

The timezone Id for the site.

string

The description of the site.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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