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

# Mark maintenance issue chat as read

> Records that the current team member has read the tenant conversation on this issue.



## OpenAPI

````yaml openapi-maintenance.json POST /v1/maintenance/issues/{id}/read
openapi: 3.1.0
info:
  title: Yorlet Maintenance API
  description: >-
    APIs for managing maintenance issues, the jobs raised against them, supplier
    quotes, and the conversation with the tenant.
  version: 1.0.0
servers:
  - url: https://api.yorlet.com
    description: Production
  - url: https://api.yorlet.io
    description: Sandbox
security: []
paths:
  /v1/maintenance/issues/{id}/read:
    post:
      tags:
        - Maintenance Issues
      summary: Mark maintenance issue chat as read
      description: >-
        Records that the current team member has read the tenant conversation on
        this issue.
      operationId: maintenance_issues_read
      parameters:
        - schema:
            type: string
            description: The id identifier.
          required: true
          description: The id identifier.
          name: id
          in: path
      responses:
        '200':
          description: Returns the maintenance issue object if the request succeeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier for the object.
                  created:
                    type: number
                    description: >-
                      Time at which the object was created. Measured in seconds
                      since the Unix epoch.
                  account:
                    type: string
                    description: >-
                      The account that the object belongs to. Only returned if
                      the request is made with a valid Yorlet-Context header.
                  deleted:
                    type: boolean
                    default: false
                    description: Only returned if the object has been deleted.
                  object:
                    type: string
                    enum:
                      - maintenance.issue
                  access_instructions:
                    type:
                      - string
                      - 'null'
                    description: >-
                      How to get into the property for the visit, for example
                      where the key safe is or which buzzer to use. Supplied by
                      the customer when they raise the issue.
                  application:
                    anyOf:
                      - type: string
                      - type: object
                        additionalProperties: {}
                      - type: 'null'
                    description: The application the issue is associated with.
                  assignee:
                    anyOf:
                      - type: string
                      - type: object
                        additionalProperties: {}
                      - type: 'null'
                    description: The user the issue is assigned to.
                  availability:
                    type:
                      - object
                      - 'null'
                    properties:
                      days_available:
                        type:
                          - array
                          - 'null'
                        items:
                          type: number
                          minimum: 0
                          maximum: 6
                        description: >-
                          Days of the week the customer is available, where 0 is
                          Sunday and 6 is Saturday.
                      every_day:
                        type: boolean
                        description: Whether the customer is available every day.
                      time_slots:
                        type:
                          - object
                          - 'null'
                        additionalProperties:
                          type: array
                          items:
                            type: object
                            properties:
                              end_time:
                                type: string
                                description: The end time of the slot.
                              start_time:
                                type: string
                                description: The start time of the slot.
                            required:
                              - end_time
                              - start_time
                        description: >-
                          Time slots, keyed by day of week, when the customer is
                          available.
                    description: >-
                      When the customer is available for a visit. `null` when
                      availability has not been set.
                    required:
                      - days_available
                      - every_day
                      - time_slots
                  customer_presence_requested:
                    type: boolean
                    description: >-
                      Whether the customer's presence is requested during the
                      maintenance visit.
                  customer_request:
                    type: boolean
                    description: Whether the issue was raised by a customer.
                  description:
                    type:
                      - string
                      - 'null'
                    description: A description of the maintenance issue.
                  first_responded_at:
                    type:
                      - integer
                      - 'null'
                    description: >-
                      The time at which the issue was first responded to, which
                      stops the response clock.
                  is_communal:
                    type: boolean
                    description: Whether the issue is in a communal area.
                  issue_category:
                    type:
                      - string
                      - 'null'
                    enum:
                      - air_conditioning
                      - appliance
                      - electricity
                      - exterior
                      - heating_system
                      - housekeeping
                      - housing
                      - locksmith
                      - other
                      - painting
                      - pest_control
                      - plumbing
                      - null
                    description: The high-level category of the issue.
                  issue_sub_category:
                    type:
                      - string
                      - 'null'
                    description: A more specific sub-category for the issue.
                  last_customer_message_at:
                    type:
                      - integer
                      - 'null'
                    default: null
                    description: >-
                      The time of the most recent message from the tenant.
                      `null` when the tenant has not written.
                  metadata:
                    type:
                      - object
                      - 'null'
                    additionalProperties:
                      type: string
                    description: Metadata for the maintenance issue.
                  name:
                    type:
                      - string
                      - 'null'
                    description: The name of the maintenance issue.
                  on_hold:
                    type:
                      - object
                      - 'null'
                    properties:
                      at:
                        type:
                          - integer
                          - 'null'
                        description: The time at which the issue was put on hold.
                      reason:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Why the issue is on hold, for example waiting on parts
                          or a contractor.
                    description: >-
                      Hold details for the issue, which pause its SLA clock and
                      exclude it from performance metrics. `null` when the issue
                      is not on hold.
                    required:
                      - at
                      - reason
                  photos:
                    type: array
                    items:
                      type: string
                    description: IDs of files used as photos for the issue.
                  priority:
                    type: number
                    minimum: 0
                    maximum: 4
                    description: >-
                      The priority of the issue, where higher numbers indicate
                      higher priority.
                  resolved:
                    type: boolean
                    description: Whether the issue has been resolved.
                  resolved_at:
                    type:
                      - integer
                      - 'null'
                    description: The time at which the issue was resolved.
                  sla:
                    type:
                      - object
                      - 'null'
                    properties:
                      paused_seconds:
                        type: number
                        description: >-
                          How long the issue has spent on hold in total, which
                          is excluded from its SLA clock.
                      resolution_due_at:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          The time by which the issue should be resolved, from
                          the targets configured for the account.
                      response_due_at:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          The time by which the issue should be responded to,
                          from the targets configured for the account.
                      status:
                        type: string
                        enum:
                          - at_risk
                          - breached
                          - met
                          - on_hold
                          - on_track
                        description: The SLA state of the issue, derived from its targets.
                    description: >-
                      The issue standing against its response and resolution
                      targets. `null` when no targets applied when it was
                      raised.
                    required:
                      - paused_seconds
                      - resolution_due_at
                      - response_due_at
                      - status
                  status:
                    type: string
                    enum:
                      - in_progress
                      - open
                      - resolved
                    description: The status of the maintenance issue.
                  triage:
                    type:
                      - object
                      - 'null'
                    properties:
                      enabled:
                        type: boolean
                        description: Whether triage is enabled for the issue.
                      portal_completion_session:
                        type:
                          - string
                          - 'null'
                        description: The session used to complete triage in the portal.
                      resolved:
                        type:
                          - boolean
                          - 'null'
                        description: Whether the triage step has been resolved.
                    description: >-
                      Triage configuration for the issue. `null` when triage is
                      not enabled.
                    required:
                      - enabled
                      - portal_completion_session
                      - resolved
                  type:
                    type: string
                    enum:
                      - customer_request
                      - internal
                      - planned
                    description: The type of the maintenance issue.
                  unread_messages:
                    type: boolean
                    default: false
                    description: >-
                      Whether the current team member has a tenant chat message
                      they have not read. Always `false` for a tenant.
                  unit:
                    anyOf:
                      - type: string
                      - type: object
                        additionalProperties: {}
                      - type: 'null'
                    description: The unit the issue is associated with.
                  videos:
                    type: array
                    items:
                      type: string
                    default: []
                    description: IDs of files used as videos for the issue.
                required:
                  - id
                  - created
                  - object
                  - access_instructions
                  - application
                  - assignee
                  - availability
                  - customer_presence_requested
                  - customer_request
                  - description
                  - first_responded_at
                  - is_communal
                  - issue_category
                  - issue_sub_category
                  - name
                  - on_hold
                  - photos
                  - priority
                  - resolved
                  - resolved_at
                  - sla
                  - status
                  - triage
                  - type
                  - unit
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API Key authentication. Use "Bearer YOUR_API_KEY".

````