openapi: 3.2.0
info:
  title: ClickFunnels Emails::Topic 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: Emails::Topic
  description: '> Email Topics


    Email Topics are used for email broadcast categorization and subscriber preferences.


    See [Sending or scheduling a broadcast](https://accounts.myclickfunnels.com/.well-known/emails/skill.md#sending-or-scheduling-a-broadcast) in the [Emails Skill](https://accounts.myclickfunnels.com/.well-known/emails/skill.md).

    '
paths:
  /workspaces/{workspace_id}/emails/topics:
    get:
      tags:
      - Emails::Topic
      summary: List Email Topics
      description: List all email topics for a workspace. Use include_archived=true to include archived topics.
      operationId: listEmailsTopics
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      - name: include_archived
        in: query
        description: Set to true to include archived topics in the results
        required: false
        schema:
          type: string
          enum:
          - 'true'
      - $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/EmailsTopicAttributes'
              example:
              - id: 1
                public_id: StUvWx
                workspace_id: 42000
                name: Product Updates
                description: Updates about our products
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 2
                public_id: YzAbCd
                workspace_id: 42000
                name: Promotions
                description: Promotional emails
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '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'
    post:
      tags:
      - Emails::Topic
      summary: Create Email Topic
      description: Create a new email topic for a workspace
      operationId: createEmailsTopic
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Email Topic
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                emails_topic:
                  type: object
                  $ref: '#/components/schemas/EmailsTopicParameters'
            example:
              emails_topic:
                name: Product Updates
                description: Updates about our products
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailsTopicAttributes'
              example:
                id: 3
                public_id: EfGhIj
                workspace_id: 42000
                name: Product Updates
                description: Updates about our products
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '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
  /emails/topics/{id}:
    get:
      tags:
      - Emails::Topic
      summary: Fetch Email Topic
      description: Retrieve a single email topic
      operationId: getEmailsTopic
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailsTopicAttributes'
              example:
                id: 1
                public_id: StUvWx
                workspace_id: 42000
                name: Product Updates
                description: Updates about our products
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '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'
    patch:
      tags:
      - Emails::Topic
      summary: Update Email Topic
      description: Update an email topic
      operationId: updateEmailsTopic
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Email Topic
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                emails_topic:
                  type: object
                  $ref: '#/components/schemas/EmailsTopicParametersUpdate'
            example:
              emails_topic:
                name: Renamed Topic
                description: Updated description
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailsTopicAttributes'
              example:
                id: 1
                public_id: StUvWx
                workspace_id: 42000
                name: Renamed Topic
                description: Updated description
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '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'
    delete:
      tags:
      - Emails::Topic
      summary: Archive Email Topic
      description: Archive an email topic. System topics cannot be archived.
      operationId: archiveEmailsTopic
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '204':
          description: No Content
        '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'
components:
  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).
  schemas:
    EmailsTopicAttributes:
      type: object
      title: Email Topics
      description: Email Topics
      properties:
        id:
          type: integer
          description: Topic ID
        public_id:
          type:
          - string
          - 'null'
          description: Topic public ID
        workspace_id:
          type: integer
          description: Workspace ID
        name:
          type: string
          description: Topic name
        description:
          type:
          - string
          - 'null'
          description: Topic description
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Created at datetime
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated at datetime
      example:
        id: 1
        public_id: StUvWx
        workspace_id: 42000
        name: Product Updates
        description: Updates about our products
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
      required:
      - created_at
      - description
      - id
      - name
      - public_id
      - updated_at
      - workspace_id
    EmailsTopicParametersUpdate:
      type: object
      title: Email Topics
      description: Email Topics
      required: []
      properties:
        name:
          type: string
          description: Topic name
        description:
          type:
          - string
          - 'null'
          description: Topic description
      example:
        emails_topic:
          name: Renamed Topic
          description: Updated description
    EmailsTopicParameters:
      type: object
      title: Email Topics
      description: Email Topics
      required:
      - name
      properties:
        name:
          type: string
          description: Topic name
        description:
          type:
          - string
          - 'null'
          description: Topic description
      example:
        emails_topic:
          name: Product Updates
          description: Updates about our products
  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