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

# Changes an alert's status: dismisses it, restores it to New, or links it to a ticket.

> `StatusId` is required: 1 New, 2 Dismissed or 3 Ticketed. Ticketed needs a `TicketId` - an
            open ticket of this account, of the alert's client when it has one - and links the alert to it, as
            creating a ticket from an alert does in the app; the alert's `TicketId` then reads that ticket.
            `TicketId` is refused with any other status.
            

            As in the app, the change applies to the alert's whole stack - the repeats grouped with it in the
            alert list: dismissing or ticketing moves every New alert in the stack, and restoring to New moves
            every Dismissed one back. A New alert can be dismissed or ticketed and a Dismissed alert restored;
            any other change - a Ticketed alert to any status or another ticket, or a Dismissed alert to
            Ticketed - is a 409. Sending the status (and ticket) the alert already has is a no-op rather than an
            error. A dismissal is reported on the alert as `DismissedOn` and `DismissedBy`.
            



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/alerts/{alertId}
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/alerts/{alertId}:
    patch:
      tags:
        - Alerts
      summary: >-
        Changes an alert's status: dismisses it, restores it to New, or links it
        to a ticket.
      description: "`StatusId` is required: 1 New, 2 Dismissed or 3 Ticketed. Ticketed needs a `TicketId` - an\r\n            open ticket of this account, of the alert's client when it has one - and links the alert to it, as\r\n            creating a ticket from an alert does in the app; the alert's `TicketId` then reads that ticket.\r\n            `TicketId` is refused with any other status.\r\n            \n\r\n            As in the app, the change applies to the alert's whole stack - the repeats grouped with it in the\r\n            alert list: dismissing or ticketing moves every New alert in the stack, and restoring to New moves\r\n            every Dismissed one back. A New alert can be dismissed or ticketed and a Dismissed alert restored;\r\n            any other change - a Ticketed alert to any status or another ticket, or a Dismissed alert to\r\n            Ticketed - is a 409. Sending the status (and ticket) the alert already has is a no-op rather than an\r\n            error. A dismissal is reported on the alert as `DismissedOn` and `DismissedBy`.\r\n            "
      operationId: patch_v1_alerts_alertId
      parameters:
        - name: alertId
          in: path
          description: Alert to change.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: The status to set, and the ticket for Ticketed.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateAlertCommand'
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAlertCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateAlertCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateAlertCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UpdateAlertResultBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAlertResultBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/UpdateAlertResultBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '409':
          description: Conflict
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    UpdateAlertCommand:
      type: object
      properties:
        StatusId:
          type: integer
          description: "The status to set: 1 New, 2 Dismissed or 3 Ticketed. Required. Ticketed links the alert to the\r\nticket in `TicketId`. As in the app, the change applies to the alert's whole stack (its\r\nrepeats): Dismissed and Ticketed move every New alert in it, New moves every Dismissed one\r\nback. A New alert can be dismissed or ticketed and a Dismissed one set back to New; any other\r\nchange, including moving a Ticketed alert, is a 409."
          format: int32
          nullable: true
          example: 2
        TicketId:
          type: string
          description: "The ticket to link the alert to, an id from `GET /v1/tickets`. Required with\r\n`StatusId` 3 and accepted with nothing else. The ticket must be an open ticket of this\r\naccount (not deleted), and of the alert's client when the alert has one."
          format: uuid
          nullable: true
      additionalProperties: false
      description: Request body for changing one alert's status.
    UpdateAlertResultBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          $ref: '#/components/schemas/UpdateAlertResult'
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    UpdateAlertResult:
      type: object
      properties:
        Id:
          type: string
          format: uuid
      additionalProperties: false
      description: The identifier of the alert.
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

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