openapi: 3.2.0
info:
  title: ClickFunnels Theme API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Theme
  description: '> Themes determine the look of the user-facing ClickFunnels pages.


    A theme bundles the relevant site pages, like home page, storefront, course pages, etc.

    '
paths:
  /workspaces/{workspace_id}/themes:
    get:
      tags:
      - Theme
      summary: List Themes
      description: List of all themes available in the workspace
      operationId: listThemes
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ThemeAttributes'
              example:
              - id: 12
                public_id: tVQNHx
                workspace_id: 42000
                name: Original Name
                custom_name: Custom Name
                current_style_id: 33
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                styles:
                - id: 33
                  name: Example Style
                - id: 34
                  name: Example Style
                template_pages: {}
              - id: 13
                public_id: uthadi
                workspace_id: 42000
                name: Original Name
                custom_name: Custom Name
                current_style_id: 35
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                styles:
                - id: 35
                  name: Example Style
                - id: 36
                  name: Example Style
                template_pages: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
  /themes/{id}:
    get:
      tags:
      - Theme
      summary: Fetch Theme
      description: Retrieve a theme
      operationId: getThemes
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThemeAttributes'
              example:
                id: 14
                public_id: tJuxnr
                workspace_id: 42000
                name: Original Name
                custom_name: Custom Name
                current_style_id: 37
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                styles:
                - id: 37
                  name: Example Style
                - id: 38
                  name: Example Style
                template_pages: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    put:
      tags:
      - Theme
      summary: Update Theme
      description: Update a theme
      operationId: updateThemes
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Theme
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                theme:
                  type: object
                  $ref: '#/components/schemas/ThemeParametersUpdate'
            example:
              theme:
                custom_name: Custom Name
                current_style_id: 5
                template_pages:
                  home_template_page: RcHPAt
                  not_found_template_page: Bd2kQ9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThemeAttributes'
              example:
                id: 15
                public_id: yBbsLE
                workspace_id: 42000
                name: Original Name
                custom_name: Custom Name
                current_style_id: 39
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                styles:
                - id: 39
                  name: Example Style
                - id: 40
                  name: Example Style
                template_pages: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
  /themes/{id}/set_default:
    post:
      tags:
      - Theme
      summary: Set Default Theme
      description: This will set the specified theme as the default theme for the current workspace.
      operationId: set_defaultThemes
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        '422':
          description: Unprocessable Entity
components:
  schemas:
    ThemeAttributes:
      type: object
      title: Themes
      description: Themes
      properties:
        id:
          type: integer
          description: Theme ID
        public_id:
          type:
          - string
          - 'null'
          description: Theme public ID
        workspace_id:
          type: integer
          description: Workspace ID
        name:
          type: string
          description: The original name of the theme
        custom_name:
          type:
          - string
          - 'null'
          description: A custom name to override the theme name
        current_style_id:
          type:
          - integer
          - 'null'
          description: The style that will be applied to the theme
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Created at
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated at
        styles:
          type:
          - array
          - 'null'
          items:
            type: object
            title: Styles
            description: Styles are used to switch between different designs for a theme
            properties:
              id:
                type: integer
                description: Style ID
              name:
                type: string
                description: Name
          description: Styles
        template_pages:
          type: object
          description: 'A map whose keys are template-type names and whose values are the public id (string) of the page that renders each template type, or null when none is configured. The object is open-ended — there are approximately 22 template types in total (for example: home_template_page, not_found_template_page, coming_soon_template_page, order_confirmation_template_page, checkout_template_page, blog_template_page, blogs_post_template_page, product_template_page, member_login_template_page, customer_center_template_page, and others).'
          additionalProperties:
            type:
            - string
            - 'null'
      example:
        id: 2
        public_id: dkGlMT
        workspace_id: 42000
        name: Original Name
        custom_name: Custom Name
        current_style_id: 5
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
        styles:
        - id: 5
          name: Example Style
        - id: 4
          name: Example Style
        template_pages:
          home_template_page: RcHPAt
          not_found_template_page: Bd2kQ9
          coming_soon_template_page: null
      required:
      - created_at
      - current_style_id
      - custom_name
      - id
      - name
      - public_id
      - styles
      - template_pages
      - updated_at
      - workspace_id
    ThemeParametersUpdate:
      type: object
      title: Themes
      description: Themes
      required: []
      properties:
        custom_name:
          type:
          - string
          - 'null'
          description: A custom name to override the theme name
        current_style_id:
          type:
          - integer
          - 'null'
          description: The style that will be applied to the theme
        template_pages:
          type: object
          description: Set which page renders each template type. Pass a partial object — only the entries you include are updated; omitted keys are left unchanged. Keys are template-type names (e.g. home_template_page, not_found_template_page); values are a page's public id, or an empty string to clear that slot. Unknown template-type names are rejected with a 422 error.
          additionalProperties:
            type: string
      example:
        theme:
          custom_name: Custom Name
          current_style_id: 5
          template_pages:
            home_template_page: RcHPAt
            not_found_template_page: Bd2kQ9
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      name: sort_property
      in: query
      description: 'Sort property of a list response. The default is id and thus the created_at order.

        If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

        '
      required: false
      schema:
        type: string
        enum:
        - id
        - updated_at
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  headers:
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com