Skip to main content
POST
/
v1
/
workspaces
/
{workspaceId}
/
sites
Create Site
curl --request POST \
  --url https://8511e6e5e351.ngrok-free.app/v1/workspaces/{workspaceId}/sites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Hearth Furniture Company",
  "hostUrl": "https://hearthfurniture.com"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Hearth Furniture Company",
  "hostUrl": "https://hearthfurniture.com",
  "apiKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

The API key for the App (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)

Path Parameters

​
workspaceId
string<uuid>
required

The ID of the workspace

Body

application/json
​
name
string
required

The name of the site

Example:

"Hearth Furniture Company"

​
hostUrl
string<uri>

The host URL of the site. The URL should consist of only the origin.

Example:

"https://hearthfurniture.com"

​
locale
string

Locale of the site locale (e.g., es-MX for Mexican Spanish, fr-CA for Canadian French).

Example:

"en-US"

Response

201 - application/json
​
id
string<uuid>
required
​
name
string
required

The name of the site

Example:

"Hearth Furniture Company"

​
hostUrl
null
required

The host URL of the site. The URL should consist of only the origin.

Example:

"https://hearthfurniture.com"

​
apiKey
string<uuid>
required