Sites

Create a site

POST

/sites

Create a site

curl --request POST \
  --url https://consent.studio/api/v1/reseller/sites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_to_prices": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "aliases": [
    "<string>"
  ],
  "banner_position": "center_center",
  "dark_mode": true,
  "detect_appearance": true,
  "domain": "<string>",
  "enable_analytics_reprompting": true,
  "enable_brand_icon": true,
  "enable_close_icon": true,
  "enable_google_consent_mode": true,
  "enable_http_cookies_via_cname": true,
  "enable_http_cookies_via_worker": true,
  "enable_implicit_consent": true,
  "enable_marketing_reprompting": true,
  "enable_reject_all_button": true,
  "enable_toggle_on_desktop": true,
  "enable_toggle_on_mobile": true,
  "enable_uet_consent_mode": true,
  "hide_inactive_categories": true,
  "highlight_accept_all_button": true,
  "languages": [
    "<string>"
  ],
  "link_to_domain": "<string>",
  "link_to_uuid": "<string>",
  "overlay_mode": true,
  "plan_uuid": "<string>",
  "primary_color": "<string>",
  "toggle_position": "left"
}
'

{
  "access_to_prices": {},
  "aliases": [
    "<any>"
  ],
  "banner_position": "<string>",
  "dark_mode": true,
  "domain": "<string>",
  "enable_analytics_reprompting": true,
  "enable_brand_icon": true,
  "enable_close_icon": true,
  "enable_google_consent_mode": true,
  "enable_http_cookies_via_cname": true,
  "enable_http_cookies_via_worker": true,
  "enable_implicit_consent": true,
  "enable_marketing_reprompting": true,
  "enable_reject_all_button": true,
  "enable_toggle_on_desktop": true,
  "enable_toggle_on_mobile": true,
  "enable_uet_consent_mode": true,
  "has_analytics_cookies": true,
  "has_functional_cookies": true,
  "has_http_consent_cookies_enabled": true,
  "has_http_consent_cookies_enabled_via_dns_record": true,
  "has_http_consent_cookies_enabled_via_worker": true,
  "has_marketing_cookies": true,
  "hide_inactive_categories": true,
  "highlight_accept_all_button": true,
  "is_active": true,
  "is_subdomain": true,
  "is_subscribed": true,
  "is_top_level_domain": true,
  "is_trialing": true,
  "languages": [
    "<any>"
  ],
  "last_health_check_at": "2023-11-07T05:31:56Z",
  "meta": {
    "billing_period": {
      "end": "<string>",
      "start": "<string>"
    },
    "usage": {
      "aliases": {
        "current": 123,
        "is_over_limit": "<string>",
        "is_unlimited": true,
        "limit": 123,
        "overage": "<any>"
      },
      "consent_actions": {
        "current": 123,
        "is_over_limit": "<string>",
        "is_unlimited": true,
        "limit": 123,
        "overage": "<any>"
      },
      "integrations": {
        "current": 123,
        "is_over_limit": "<string>",
        "is_unlimited": true,
        "limit": 123,
        "overage": "<any>"
      },
      "languages": {
        "current": 123,
        "is_over_limit": "<string>",
        "is_unlimited": true,
        "limit": 123,
        "overage": "<any>"
      }
    }
  },
  "overlay_mode": true,
  "parent_site": "<string>",
  "primary_color": "<string>",
  "subscribed_plan": "<string>",
  "subscribed_price": "<string>",
  "toggle_position": "<string>",
  "uuid": "<string>"

Authorizations

Authorizationstringheaderrequired

A reseller API token, issued by Consent Studio support.

Body

access_to_pricesstring[] | null

aliasesstring[]

banner_positionenum<string> | null

Available options: center_center, bottom_center, bottom_left, bottom_right, top_center, top_left, top_right, left_center, right_center

dark_modeboolean | null

detect_appearanceboolean | null

domainstringrequired

Maximum string length: 255

Pattern: ^(?!www\.)(([a-z0-9\-])*\.)*([a-z0-9\-])*\.[a-z]{2,13}$

enable_analytics_repromptingboolean | null

enable_brand_iconboolean | null

enable_close_iconboolean | null

enable_http_cookies_via_cnameboolean | null

enable_http_cookies_via_workerboolean | null

enable_marketing_repromptingboolean | null

enable_reject_all_buttonboolean | null

enable_toggle_on_desktopboolean | null

enable_toggle_on_mobileboolean | null

hide_inactive_categoriesboolean | null

highlight_accept_all_buttonboolean | null

languagesstring[]

link_to_domainstring | null

Maximum string length: 255

link_to_uuidstring | null

Maximum string length: 255

overlay_modeboolean | null

plan_uuidstring | null

Maximum string length: 255

primary_colorstring | null

Required string length: 3 - 7

toggle_positionenum<string> | null

Available options: left, right

Response

Created.

access_to_pricesobjectrequired

aliasesany[]required

dark_modebooleanrequired

domainstringrequired

enable_analytics_repromptingbooleanrequired

enable_brand_iconbooleanrequired

enable_close_iconbooleanrequired

enable_http_cookies_via_cnamebooleanrequired

enable_http_cookies_via_workerbooleanrequired

enable_marketing_repromptingbooleanrequired

enable_reject_all_buttonbooleanrequired

enable_toggle_on_desktopbooleanrequired

enable_toggle_on_mobilebooleanrequired

has_analytics_cookiesbooleanrequired

has_functional_cookiesbooleanrequired

has_marketing_cookiesbooleanrequired

hide_inactive_categoriesbooleanrequired

highlight_accept_all_buttonbooleanrequired

is_activebooleanrequired

is_subdomainbooleanrequired

is_subscribedbooleanrequired

is_top_level_domainbooleanrequired

is_trialingbooleanrequired

languagesany[] | nullrequired

last_health_check_atstring | nullrequired

metaobjectrequired

Show child attributes

overlay_modebooleanrequired

parent_sitestring | nullrequired

primary_colorstring | nullrequired

subscribed_planstring | nullrequired

subscribed_pricestring | nullrequired

toggle_positionstring | enum<string>required

uuidstringrequired

Still need help? Ask the team