---
title: "Create a custom page set"
method: POST
path: "/waap/v1/custom-page-sets"
tags: ["Custom Page Sets"]
---

# Create a custom page set

`POST /waap/v1/custom-page-sets`

Create a custom page set based on the provided data.
For any custom page type (block, `block_csrf`, etc) that is not provided the default page will be used.

## Request body

- CustomPageSetCreate — Create a custom page set
  - `domains` integer[], nullable — List of domain IDs that are associated with this page set
  - `block` BlockPageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `block_csrf` BlockCsrfPageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `captcha` CaptchaPageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `text` string — The text to display in the body of the custom page
    - `error` string — Error message
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `cookie_disabled` CookieDisabledPageData
    - `header` string — The text to display in the header of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `handshake` HandshakePageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `javascript_disabled` JavascriptDisabledPageData
    - `header` string — The text to display in the header of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `name` string, required — Name of the custom page set

## Response `201`

Successful Response

- CustomPageSetResponse
  - `domains` integer[], nullable — List of domain IDs that are associated with this page set
  - `block` BlockPageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `block_csrf` BlockCsrfPageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `captcha` CaptchaPageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `text` string — The text to display in the body of the custom page
    - `error` string — Error message
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `cookie_disabled` CookieDisabledPageData
    - `header` string — The text to display in the header of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `handshake` HandshakePageData
    - `logo` string — Supported image types are JPEG, PNG and JPG, size is limited to width 450px, height 130px. This should be a base 64 encoding of the full HTML img tag compatible image, with the header included.
    - `header` string — The text to display in the header of the custom page
    - `title` string — The text to display in the title of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `javascript_disabled` JavascriptDisabledPageData
    - `header` string — The text to display in the header of the custom page
    - `text` string — The text to display in the body of the custom page
    - `enabled` boolean, required — Indicates whether the custom custom page is active or inactive
  - `name` string, required — Name of the custom page set
  - `id` integer, required — The ID of the custom page set

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Unauthenticated
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/g-core/apis/gcore-openapi.md) · [All operations](https://skmtc.net/g-core/apis/gcore-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/g-core/gcore-openapi/versions/09e652815095/schema)
