---
title: "POST /signup-data"
method: POST
path: "/signup-data"
tags: ["signup", "utility"]
---

# POST /signup-data

`POST /signup-data`

Save docs data on signup

## Request body

- object
  - `version` ProjectVersion, required
    - `uid` string, required
    - `name` string, required
    - `primaryGuideId` string, required
    - `primaryReferenceId` string, required
    - `references` object, required
    - `guides` object, required
    - `header` HeaderLink[], required
      - union
        - HeaderLinkGuide
          - `uid` string, required
          - `title` string, required
          - `show` boolean, required
          - `isStarred` boolean, required
          - `type` 'guide', required
        - HeaderLinkReference
          - `uid` string, required
          - `title` string, required
          - `show` boolean, required
          - `isStarred` boolean, required
          - `type` 'reference', required
          - `hasPermalink` boolean, required — Whether the reference has a permalinked reference or not
          - `hasManagedDoc` boolean, required — Whether the reference has a linked registry API
        - HeaderLinkGroup
          - `uid` string, required
          - `title` string, required
          - `show` boolean, required
          - `isStarred` boolean, required
          - `type` 'group', required
          - `children` union[], required — Children of the group. Groups cannot contain other groups, spacers, or the version selector
            - union
              - …
        - HeaderLinkExternal
          - `uid` string, required
          - `title` string, required
          - `show` boolean, required
          - `isStarred` boolean, required
          - `type` 'link', required
          - `isButton` boolean, required
          - `link` string, required
        - HeaderLinkVersionSelector
          - `uid` string, required
          - `title` string, required
          - `show` boolean, required
          - `isStarred` boolean, required
          - `type` 'version-selector', required
        - HeaderLinkSpacer
          - `uid` string, required
          - `title` string, required
          - `show` boolean, required
          - `isStarred` boolean, required
          - `type` 'spacer', required
    - `footer` string, required
    - `footerCss` string, required
    - `footerBelowSidebar` boolean, required
    - `headScript` string, required
    - `bodyScript` string, required
  - `theme` Theme
    - `uid` string, required
    - `name` string, required
    - `description` string, required
    - `theme` string, required
    - `slug` string, required
  - `yjsDocs` object, required
  - `yjsReferences` object, required

## Response `200`

Default Response

- object
  - `dataUid` string, required

## Other responses

- `400` — Bad request
- `401` — No auth
- `403` — Forbidden
- `404` — Not found
- `422` — Invalid payload
- `500` — Uncaught error

---

[API](https://skmtc.net/scalar/apis/core.md) · [All operations](https://skmtc.net/scalar/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalar/core/revisions/f2eb95a82c72/schema)