Create a site

Authorization

ApiKeyAuth

AuthorizationBearer <token>

A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Display name (1–200 characters).

Length1 <= length <= 200

platform*SitePlatform

The platform the site runs on. Most values are e-commerce platforms (shopify, prestashop, woocommerce, commercetools, bigcommerce, adobe_commerce, salesforce_commerce, sap_commerce, wix); hubspot, wordpress, and wix_site are non-commerce website builders/CMSs (a marketing site rather than a storefront).

Value in

"shopify"
"prestashop"
"woocommerce"
"commercetools"
"bigcommerce"
"adobe_commerce"
"salesforce_commerce"
"sap_commerce"
"wix"
"hubspot"
"wordpress"
"wix_site"
"custom"

url*string

The storefront's public address. A bare domain (e.g. mystore.com) is accepted and auto-prefixed with https://; the stored value must resolve to a valid URL. Also seeded as this site's first allowed origin for embedding.

Length1 <= length

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/api/v1/sites" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Demo Storefront",
    "platform": "shopify",
    "url": "https://demo-storefront.example.com"
  }'

curl -X POST "https://example.com/api/v1/sites" \  -H "Content-Type: application/json" \  -d '{    "name": "Demo Storefront",    "platform": "shopify",    "url": "https://demo-storefront.example.com"  }'

{
  "data": {
    "resumeButton": {
      "position": "left",
      "offsetBottom": 0,
      "offsetSide": 0,
      "offsetBottomNarrow": 0,
      "offsetSideNarrow": 0,
      "colors": {
        "background": "string",
        "icon": "string",
        "border": "string"
      },
      "icon": "sparkle",
      "size": "sm",
      "radius": "none",
      "shadow": "none"
    },
    "id": "string",
    "name": "string",
    "platform": "shopify",
    "url": "string",
    "siteInformation": "string",
    "toneOfVoice": "string",
    "vertical": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "autoGenerateStarters": true,
    "switchOnGeneratedStarters": true,
    "pageViewCountingEnabled": true,
    "storefrontCartCountingEnabled": true,
    "autoReadPages": true,
    "autoReadMinViews": 0,
    "tagMonitoringEnabled": true,
    "panelColors": {
      "panel": {
        "background": "string"
      },
      "actions": {
        "fill": "string",
        "text": "string",
        "hover": "string",
        "border": "string"
      },
      "visitor": {
        "fill": "string",
        "text": "string"
      },
      "highlights": {
        "fill": "string",
        "text": "string"
      },
      "assistant": {
        "text": "string"
      },
      "links": {
        "color": "string"
      },
      "suggestions": {
        "fill": "string",
        "text": "string",
        "border": "string"
      }
    },
    "panelPosition": "left",
    "panelBackdrop": true,
    "hostedPage": {
      "enabled": true,
      "link": "string"
    },
    "defaultAgentId": "string",
    "analysisState": "running"
  }
}

{  "data": {    "resumeButton": {      "position": "left",      "offsetBottom": 0,      "offsetSide": 0,      "offsetBottomNarrow": 0,      "offsetSideNarrow": 0,      "colors": {        "background": "string",        "icon": "string",        "border": "string"      },      "icon": "sparkle",      "size": "sm",      "radius": "none",      "shadow": "none"    },    "id": "string",    "name": "string",    "platform": "shopify",    "url": "string",    "siteInformation": "string",    "toneOfVoice": "string",    "vertical": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "autoGenerateStarters": true,    "switchOnGeneratedStarters": true,    "pageViewCountingEnabled": true,    "storefrontCartCountingEnabled": true,    "autoReadPages": true,    "autoReadMinViews": 0,    "tagMonitoringEnabled": true,    "panelColors": {      "panel": {        "background": "string"      },      "actions": {        "fill": "string",        "text": "string",        "hover": "string",        "border": "string"      },      "visitor": {        "fill": "string",        "text": "string"      },      "highlights": {        "fill": "string",        "text": "string"      },      "assistant": {        "text": "string"      },      "links": {        "color": "string"      },      "suggestions": {        "fill": "string",        "text": "string",        "border": "string"      }    },    "panelPosition": "left",    "panelBackdrop": true,    "hostedPage": {      "enabled": true,      "link": "string"    },    "defaultAgentId": "string",    "analysisState": "running"  }}

Create a site

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/problem+json

401application/problem+json

429application/problem+json

500application/problem+json

Authorization

Request Body

Response Body

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`