Skilljar Domains > Catalog Pages (Builder) > HTML Content Blocks API

openapi: 3.0.3
info:
  title: Skilljar Assets Domains > Catalog Pages (Builder) > HTML Content Blocks API
  version: 1.0.0
  description: 'The Skilljar API provides comprehensive access to our customer education platform, enabling you to programmatically manage courses, users, enrollments, and more.


    This interactive documentation is automatically generated from our codebase and stays current with the latest features and endpoints.


    ## Getting Started


    New to the Skilljar API? Check out these essential resources:


    - **[API Getting Started Guide](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Getting_started_with_the_Skilljar_API)** - Authentication, basic concepts, and your first API call

    - **[Token-based SSO](https://support.gainsight.com/Skilljar/Develop_and_Customize/Single_Sign_on_(SSO)/Configuring_Token-Based_Single_Sign-On_(SSO))** - Seamlessly integrate user authentication

    - **[Webhooks](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Using_Webhooks_API)** - Real-time notifications for platform events

    '
tags:
- name: Domains > Catalog Pages (Builder) > HTML Content Blocks
paths:
  /v1/domains/{domain_name}/catalog-pages/{catalog_page_id}/html-content-blocks/{id}:
    get:
      operationId: domains_catalog_pages_html_content_blocks_retrieve
      description: Retrieve details of the specified HTML content block on the specified builder catalog page
      parameters:
      - in: path
        name: catalog_page_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Domains > Catalog Pages (Builder) > HTML Content Blocks
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlContentBlock'
          description: ''
    put:
      operationId: domains_catalog_pages_html_content_blocks_update
      description: Updates HTML content for a specified html content block on a specified builder catalog page
      parameters:
      - in: path
        name: catalog_page_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Domains > Catalog Pages (Builder) > HTML Content Blocks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HtmlContentBlockRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HtmlContentBlockRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/HtmlContentBlockRequest'
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlContentBlock'
          description: ''
    patch:
      operationId: domains_catalog_pages_html_content_blocks_partial_update
      description: Updates HTML content for a specified html content block on a specified catalog page
      parameters:
      - in: path
        name: catalog_page_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Domains > Catalog Pages (Builder) > HTML Content Blocks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedHtmlContentBlockRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedHtmlContentBlockRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedHtmlContentBlockRequest'
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlContentBlock'
          description: ''
components:
  schemas:
    HtmlContentBlock:
      type: object
      description: Serializer for HTML content blocks
      properties:
        id:
          type: string
          readOnly: true
        content_block_id:
          type: string
          readOnly: true
        html:
          type: string
          maxLength: 100000
    PatchedHtmlContentBlockRequest:
      type: object
      description: Serializer for HTML content blocks
      properties:
        html:
          type: string
          maxLength: 100000
    HtmlContentBlockRequest:
      type: object
      description: Serializer for HTML content blocks
      properties:
        html:
          type: string
          maxLength: 100000
  securitySchemes:
    OrganizationApiKey:
      type: http
      scheme: basic
      description: API key authentication using HTTP Basic Auth. Use your API key as the username and leave password empty.
    tokenAuth:
      type: http
      scheme: bearer