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

# Publish or unpublish a page, folder, or project

> Sets the explicit publish state on the supplied targets and re-materialises `isPublished` across the project.

Descendants inherit the state unless they carry an explicit one of their own.

The caller must have edit permission on all supplied targets.



## OpenAPI

````yaml post /published/publish-state
openapi: 3.1.0
info:
  title: HERO API
  version: current
  description: |-
    The HERO REST API.

    See https://developers.myhero.so for the rendered docs.
servers:
  - url: https://app.myhero.so
security: []
paths:
  /published/publish-state:
    post:
      tags:
        - Published
      summary: Publish or unpublish a page, folder, or project
      description: >-
        Sets the explicit publish state on the supplied targets and
        re-materialises `isPublished` across the project.


        Descendants inherit the state unless they carry an explicit one of their
        own.


        The caller must have edit permission on all supplied targets.
      operationId: setPublishState
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                targetIds:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
                target:
                  type: string
                  enum:
                    - project
                    - document
                state:
                  type: string
                  enum:
                    - 'on'
                    - 'off'
                    - inherit
                excludeIds:
                  type: array
                  items:
                    type: string
                    minLength: 1
                includeIds:
                  type: array
                  items:
                    type: string
                    minLength: 1
                address:
                  type: string
                  minLength: 1
                  maxLength: 80
              required:
                - targetIds
                - target
                - state
      responses:
        '200':
          description: 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      effective:
                        type: string
                        enum:
                          - 'on'
                          - 'off'
                      live:
                        type: number
                      pending:
                        type: number
                      excluded:
                        type: number
                      settings:
                        type: object
                        properties:
                          publishedById:
                            type: string
                          publishedAt:
                            type: number
                          styling:
                            type: object
                            additionalProperties:
                              anyOf:
                                - type: string
                                - type: boolean
                          domainSlug:
                            type: string
                        required:
                          - publishedById
                          - publishedAt
                    required:
                      - effective
                      - live
                      - pending
                      - excluded
                      - settings
                required:
                  - data
        '400':
          description: 400 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: |-
                      Error class name (e.g.

                      ValidationError, NotFound)
                  message:
                    type: string
                    description: Human-readable error message
                  details:
                    type: array
                    items: {}
                required:
                  - error
                  - message
        '403':
          description: 403 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: |-
                      Error class name (e.g.

                      ValidationError, NotFound)
                  message:
                    type: string
                    description: Human-readable error message
                  details:
                    type: array
                    items: {}
                required:
                  - error
                  - message
        '404':
          description: 404 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: |-
                      Error class name (e.g.

                      ValidationError, NotFound)
                  message:
                    type: string
                    description: Human-readable error message
                  details:
                    type: array
                    items: {}
                required:
                  - error
                  - message
        '409':
          description: 409 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: |-
                      Error class name (e.g.

                      ValidationError, NotFound)
                  message:
                    type: string
                    description: Human-readable error message
                  details:
                    type: array
                    items: {}
                required:
                  - error
                  - message
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: HERO personal access token

````