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

# Report roadmap content

> Flags an item or a comment for staff to review. Reports are private.



## OpenAPI

````yaml /openapi/backend.json post /v1/roadmapBoards/{board}/reports
openapi: 3.0.0
info:
  title: Plazza API
  description: >-
    The Plazza REST API. Errors follow AIP-193 and carry a message in the
    language of Accept-Language, French or English.
  version: v1
servers:
  - url: https://api.plazza.ca
security:
  - bearer: []
paths:
  /v1/roadmapBoards/{board}/reports:
    post:
      tags:
        - Roadmap
      summary: Report roadmap content
      description: Flags an item or a comment for staff to review. Reports are private.
      operationId: RoadmapParticipation.report
      parameters:
        - name: board
          required: true
          in: path
          description: 'The board: `hire` for employers, `talents` for job seekers.'
          schema:
            type: string
            enum:
              - hire
              - talents
            description: 'The board: `hire` for employers, `talents` for job seekers.'
            example: hire
        - name: requestId
          required: false
          in: query
          description: >-
            Makes a retry safe: a request with the same id and content returns
            the resource the first one created.
          schema:
            description: >-
              Makes a retry safe: a request with the same id and content returns
              the resource the first one created.
            example: 0f5e8c1e-7a8b-4c2d-9e1f-2a3b4c5d6e7f
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoadmapReportInput'
      responses:
        '200':
          description: >-
            A private report of an item or comment, for staff to review. It
            never names the reporter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoadmapReport'
        default:
          description: An AIP-193 error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RoadmapReportInput:
      type: object
      properties:
        item:
          type: string
          maxLength: 300
          description: >-
            The resource name of the item to report, or of the reported
            comment’s item.
          example: roadmapBoards/hire/items/019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e
        comment:
          default: null
          description: The resource name of the comment to report, if it’s a comment.
          example: null
          nullable: true
          type: string
          maxLength: 300
        reason:
          type: string
          enum:
            - SPAM
            - ABUSE
            - PRIVACY
            - OTHER
          description: 'What is wrong: spam, abuse, personal information, or something else.'
          example: SPAM
        details:
          default: ''
          description: Anything staff should know, up to 2,000 characters.
          example: Advertises an unrelated product.
          type: string
          maxLength: 10000
      required:
        - item
        - reason
      additionalProperties: false
      description: A private report for staff to review.
    RoadmapReport:
      type: object
      properties:
        name:
          type: string
          description: The report's resource name.
          example: roadmapBoards/hire/reports/019a7c33-5d6e-7f80-9a1b-2c3d4e5f6a7b
        item:
          type: string
          description: The reported item, or the item of the reported comment.
          example: roadmapBoards/hire/items/019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e
        comment:
          nullable: true
          description: The reported comment. Null when the item itself is reported.
          example: >-
            roadmapBoards/hire/items/019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e/comments/019a7c31-0e2f-7a1b-8c3d-4e5f6a7b8c9d
          type: string
        reason:
          type: string
          enum:
            - SPAM
            - ABUSE
            - PRIVACY
            - OTHER
          description: 'What is wrong: spam, abuse, personal information, or something else.'
          example: SPAM
        details:
          type: string
          description: What the reporter added. Private to staff and the reporter.
          example: Advertises an unrelated product.
        state:
          type: string
          enum:
            - OPEN
            - RESOLVED
          description: Whether staff dealt with it.
          example: OPEN
        createTime:
          type: string
          format: date-time
          description: When it was filed.
          example: '2026-11-07T10:02:13.004Z'
        resolveTime:
          nullable: true
          description: When staff resolved it.
          example: null
          type: string
          format: date-time
      required:
        - name
        - item
        - comment
        - reason
        - details
        - state
        - createTime
        - resolveTime
      additionalProperties: false
      description: >-
        A private report of an item or comment, for staff to review. It never
        names the reporter.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            message:
              type: string
            status:
              type: string
              enum:
                - INVALID_ARGUMENT
                - FAILED_PRECONDITION
                - OUT_OF_RANGE
                - UNAUTHENTICATED
                - PERMISSION_DENIED
                - NOT_FOUND
                - ABORTED
                - ALREADY_EXISTS
                - RESOURCE_EXHAUSTED
                - INTERNAL
                - UNIMPLEMENTED
                - UNAVAILABLE
                - DEADLINE_EXCEEDED
            details:
              type: array
              items:
                oneOf:
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.ErrorInfo
                      reason:
                        type: string
                      domain:
                        type: string
                      metadata:
                        type: object
                        additionalProperties:
                          type: string
                    required:
                      - '@type'
                      - reason
                      - domain
                    additionalProperties: false
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.LocalizedMessage
                      locale:
                        type: string
                      message:
                        type: string
                    required:
                      - '@type'
                      - locale
                      - message
                    additionalProperties: false
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.BadRequest
                      fieldViolations:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            description:
                              type: string
                          required:
                            - field
                            - description
                          additionalProperties: false
                    required:
                      - '@type'
                      - fieldViolations
                    additionalProperties: false
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.RetryInfo
                      retryDelay:
                        type: string
                        pattern: ^\d+s$
                    required:
                      - '@type'
                      - retryDelay
                    additionalProperties: false
          required:
            - code
            - message
            - status
            - details
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: An AIP-193 error.
      example:
        error:
          code: 401
          message: Unauthorized
          status: UNAUTHENTICATED
          details:
            - '@type': type.googleapis.com/google.rpc.ErrorInfo
              reason: MISSING_CREDENTIALS
              domain: api.plazza.ca
            - '@type': type.googleapis.com/google.rpc.LocalizedMessage
              locale: en
              message: Sign in to continue.
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: >-
        The session token of a signed-in Plazza account, sent as `Authorization:
        Bearer <token>`.

````

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