> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trackup.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a builder page from catalog blocks

> Requires page.create. Creates a builder page (editable later in the Trackup builder) from blocks of listPageBlocks; it is a draft until publishPage. page: { title, description?, basedOnPreset?, theme?: { primary: "#RRGGBB", accent?, mode: "light" | "dark" }, blocks: [{ type, overrides?: { fields?: { "<field path>": "text" }, items?: [{ "<item key>": "text" }] } }] }. Field paths and item keys come from the block in listPageBlocks; texts longer than a field max are cut. A preset supplies its sections and a block of the same type replaces the preset one. Content that cannot be placed is listed in warnings.



## OpenAPI

````yaml https://api.trackup.me/openapi.json post /v1/projects/{id}/pages/compose
openapi: 3.1.0
info:
  title: Trackup API
  description: >-
    API-key-accessible Trackup operations. Send your key in the `X-Api-Key`
    header.


    Keys belong to a team. `X-Team-Id` is not required; if supplied, it must
    match that team.


    Each operation lists its required key permission. The key creator must
    remain a team member and normally hold that permission. The ingest-only
    permissions `visitor.create`, `conversion.create`, and `request.create` do
    not need to be held by the creator.


    Project access and selection are described per operation. Session-only
    account, administration and OAuth operations are not part of this reference.


    The same operations are available as MCP tools at `/mcp` (Streamable HTTP).
    Authenticate with `X-Api-Key` or connect through OAuth, which issues an API
    key on consent.


    Schema validation errors return HTTP 422 with an `errors` object. Other
    errors generally contain `error` and `message`; operation-specific responses
    describe exceptions.
  version: 1.0.0
servers:
  - url: /
    description: Current API environment
security:
  - ApiKey: []
paths:
  /v1/projects/{id}/pages/compose:
    post:
      tags:
        - Pages
      summary: Create a builder page from catalog blocks
      description: >-
        Requires page.create. Creates a builder page (editable later in the
        Trackup builder) from blocks of listPageBlocks; it is a draft until
        publishPage. page: { title, description?, basedOnPreset?, theme?: {
        primary: "#RRGGBB", accent?, mode: "light" | "dark" }, blocks: [{ type,
        overrides?: { fields?: { "<field path>": "text" }, items?: [{ "<item
        key>": "text" }] } }] }. Field paths and item keys come from the block
        in listPageBlocks; texts longer than a field max are cut. A preset
        supplies its sections and a block of the same type replaces the preset
        one. Content that cannot be placed is listed in warnings.
      operationId: composeBuilderPage
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                purpose:
                  type: string
                  enum:
                    - landing
                    - checkout
                  default: landing
                pathname:
                  type: string
                  pattern: ^\/?[a-zA-Z0-9\-._~/]+$
                  minLength: 1
                  maxLength: 1024
                salesPlatformId:
                  type: string
                  format: uuid
                page:
                  type: object
                  properties:
                    title:
                      type: string
                      minLength: 1
                      maxLength: 120
                    description:
                      type: string
                      maxLength: 300
                    basedOnPreset:
                      type: string
                    theme:
                      type: object
                      properties:
                        primary:
                          type: string
                          pattern: ^#[0-9a-fA-F]{6}$
                        accent:
                          type: string
                          pattern: ^#[0-9a-fA-F]{6}$
                        mode:
                          type: string
                          enum:
                            - light
                            - dark
                          default: light
                      required:
                        - primary
                      additionalProperties: false
                    blocks:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                          overrides:
                            type: object
                            properties:
                              fields:
                                type: object
                                additionalProperties:
                                  type: string
                              items:
                                type: array
                                items:
                                  type: object
                                  additionalProperties:
                                    type: string
                                maxItems: 16
                            additionalProperties: false
                        required:
                          - type
                        additionalProperties: false
                      minItems: 0
                      maxItems: 14
                  required:
                    - title
                    - blocks
                  additionalProperties: false
              required:
                - name
                - page
      responses:
        '201':
          description: Created page and compile warnings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComposedBuilderPage'
        '400':
          description: Malformed request or an invalid operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: The X-Api-Key header is missing or the API key is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The key is expired, revoked, lacks permission, or its creator no
            longer has the required team access. A conflicting X-Team-Id is also
            rejected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            The requested resource was not found or is outside the permitted
            scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: The operation conflicts with existing data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            Invalid input. Each field path maps to its first validation message;
            _form identifies an object-level error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ComposedBuilderPage:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/CreatedPage'
        warnings:
          type: array
          items:
            type: string
      required:
        - page
        - warnings
    ApiError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      additionalProperties: true
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: string
      required:
        - errors
    CreatedPage:
      type: object
      properties:
        id:
          type: string
          format: uuid
        projectId:
          type: string
          format: uuid
        name:
          type: string
        type:
          type: string
          enum:
            - redirect
            - builder
            - html
        createdAt:
          type: string
          format: date-time
        link:
          $ref: '#/components/schemas/PageLink'
      required:
        - id
        - projectId
        - name
        - type
        - createdAt
        - link
      example:
        id: 33333333-3333-4333-8333-333333333333
        name: Autumn offer
        type: redirect
        createdAt: '2026-10-26T12:00:00.000Z'
        projectId: 11111111-1111-4111-8111-111111111111
        link:
          id: 99999999-9999-4999-8999-999999999999
          name: Autumn offer
          pathname: /autumn-offer
          type: generic
          urls:
            - id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
              pageId: 33333333-3333-4333-8333-333333333333
              salesPlatformId: null
              name: Autumn offer
              weight: 1
              isActive: true
    PageLink:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        pathname:
          type: string
        type:
          type: string
          enum:
            - generic
            - traffic_source
            - sales_platform
        urls:
          type: array
          items:
            $ref: '#/components/schemas/UrlVariant'
      required:
        - id
        - name
        - pathname
        - type
        - urls
      example:
        id: 99999999-9999-4999-8999-999999999999
        name: Autumn offer
        pathname: /autumn-offer
        type: generic
        urls:
          - id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
            pageId: 33333333-3333-4333-8333-333333333333
            salesPlatformId: null
            name: Autumn offer
            weight: 1
            isActive: true
    UrlVariant:
      type: object
      properties:
        id:
          type: string
          format: uuid
        pageId:
          type: string
          format: uuid
        salesPlatformId:
          type:
            - string
            - 'null'
          format: uuid
        name:
          type: string
        weight:
          type: number
        isActive:
          type: boolean
      required:
        - id
        - pageId
        - salesPlatformId
        - name
        - weight
        - isActive
      example:
        id: 55555555-5555-4555-8555-555555555555
        pageId: 33333333-3333-4333-8333-333333333333
        salesPlatformId: null
        name: Landing A
        weight: 50
        isActive: true
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.