signup
utility

Changed on

Save docs data on signup

post/signup-data

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/signup-data
  • Auth
    none required

Request body

yjsDocsobject required
yjsReferencesobject required

Example request

{
  "version": {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "header": [
      {
        "uid": "UakgbKJ5m9gl0JDMbcJqL"
      }
    ]
  },
  "theme": {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "name": "Acme Theme",
    "description": "Custom colors for Acme documentation.",
    "theme": ":root { --scalar-color-1: #1f2937; }",
    "slug": "acme-api"
  }
}

Response

Default Response

dataUidstring required

Changes

  • f6130fc9c357Revision changes
    • info

      the //////// request property's minLength was decreased from 3 to 2

  • 8dff1e93bc68Revision changes
    • info

      api operation id postsignupData removed and replaced with postSignupData