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

# Update a claim

> Updates the title and status in one transaction. Null clears the title. A completed claim cannot be cancelled directly; reopen it first. Cancelling dismisses pending and accepted verdicts, including credited members; credit is kept. Reopening does not change alert verdicts.



## OpenAPI

````yaml /openapi-preview.json patch /v1/claims/{id}
openapi: 3.1.0
info:
  title: Watchdog API
  version: 1.0.0
  description: >-
    The Watchdog API is served from https://api-canary.watchdog.no until it
    moves to https://api.watchdog.no. Request bodies are limited to 2 MiB unless
    an endpoint says otherwise. Files are uploaded directly to storage, not
    through the API.
servers:
  - url: https://api-canary.watchdog.no
    description: Watchdog API
security: []
paths:
  /v1/claims/{id}:
    patch:
      tags:
        - Claims
      summary: Update a claim
      description: >-
        Updates the title and status in one transaction. Null clears the title.
        A completed claim cannot be cancelled directly; reopen it first.
        Cancelling dismisses pending and accepted verdicts, including credited
        members; credit is kept. Reopening does not change alert verdicts.
      operationId: updateClaim
      parameters:
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            The organization to act in. Required for personal API keys; list the
            organizations you can access with GET /v1/organizations.
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 200
                status:
                  type: string
                  enum:
                    - pending
                    - in_progress
                    - completed
                    - cancelled
              additionalProperties: false
      responses:
        '200':
          description: The claim with its current counts and amounts.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Claim'
        '400':
          description: >-
            The request is invalid. details lists up to 20 field errors. Request
            bodies are limited to 2 MiB.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_validation_error'
              example:
                error:
                  code: validation_error
                  message: >-
                    The request is invalid. details lists up to 20 field errors.
                    Request bodies are limited to 2 MiB.
                  request_id: req_example
        '401':
          description: The bearer token is missing or invalid.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            WWW-Authenticate:
              schema:
                type: string
              required: false
              description: Bearer authentication challenge, when supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_invalid_token'
              example:
                error:
                  code: invalid_token
                  message: The bearer token is missing or invalid.
                  request_id: req_example
        '403':
          description: >-
            Access denied. The error code says why: forbidden, token_disabled,
            organization_required, insufficient_role or mfa_required.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required
              example:
                error:
                  code: forbidden
                  message: >-
                    Access denied. The error code says why: forbidden,
                    token_disabled, organization_required, insufficient_role or
                    mfa_required.
                  request_id: req_example
        '404':
          description: The resource does not exist in the current organization.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_not_found'
              example:
                error:
                  code: not_found
                  message: The resource does not exist in the current organization.
                  request_id: req_example
        '409':
          description: >-
            The claim is completed and locked, or the change is not allowed in
            its current status.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_conflict'
              example:
                error:
                  code: conflict
                  message: >-
                    The claim is completed and locked, or the change is not
                    allowed in its current status.
                  request_id: req_example
        '429':
          description: Too many requests. Wait for the Retry-After delay before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_rate_limit_exceeded'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Wait for the Retry-After delay before
                    retrying.
                  request_id: req_example
        '500':
          description: >-
            Unexpected server failure. Include the request ID when contacting
            support.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_internal_error'
              example:
                error:
                  code: internal_error
                  message: >-
                    Unexpected server failure. Include the request ID when
                    contacting support.
                  request_id: req_example
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After delay, when
            provided.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_service_unavailable'
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Temporarily unavailable. Retry after the Retry-After delay,
                    when provided.
                  request_id: req_example
      security:
        - ApiKeyBearer: []
components:
  schemas:
    Claim:
      type: object
      properties:
        id:
          type: string
          format: uuid
        agreement:
          type: object
          properties:
            id:
              type: string
              format: uuid
            title:
              type:
                - string
                - 'null'
          required:
            - id
            - title
        suppliers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
            required:
              - id
              - name
        title:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - pending
            - in_progress
            - completed
            - cancelled
        creator:
          type:
            - object
            - 'null'
          properties:
            user_id:
              type:
                - string
                - 'null'
            label:
              type:
                - string
                - 'null'
            deleted:
              type: boolean
              description: >-
                The creator account was deleted. The label keeps their name, or
                is null once the account is anonymised.
          required:
            - user_id
            - label
            - deleted
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        refund_summary:
          type: object
          properties:
            refund_count:
              type: integer
            amount_by_currency:
              type: array
              items:
                type: object
                properties:
                  currency_code:
                    type: string
                  amount:
                    type: string
                    pattern: ^-?\d+(?:\.\d+)?$
                required:
                  - currency_code
                  - amount
          required:
            - refund_count
            - amount_by_currency
        summary:
          type: object
          properties:
            total:
              type: object
              properties:
                alert_count:
                  type: integer
                invoice_count:
                  type: integer
                  description: >-
                    Distinct invoices. An invoice counts once in total, and once
                    in each part it has alerts in.
                topic_count:
                  type: integer
                  description: >-
                    Distinct topics. A topic counts once in total, and once in
                    each part it has alerts in.
                impact_by_currency:
                  type: array
                  items:
                    type: object
                    properties:
                      currency_code:
                        type: string
                      amount:
                        type: string
                        pattern: ^-?\d+(?:\.\d+)?$
                    required:
                      - currency_code
                      - amount
                  description: Alert impact per original currency.
              required:
                - alert_count
                - invoice_count
                - topic_count
                - impact_by_currency
              description: All alerts in the claim.
            by_verdict:
              type: object
              properties:
                pending:
                  type: object
                  properties:
                    credited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        invoice_count:
                          type: integer
                          description: >-
                            Distinct invoices. An invoice counts once in total,
                            and once in each part it has alerts in.
                        topic_count:
                          type: integer
                          description: >-
                            Distinct topics. A topic counts once in total, and
                            once in each part it has alerts in.
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - invoice_count
                        - topic_count
                        - impact_by_currency
                    uncredited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        invoice_count:
                          type: integer
                          description: >-
                            Distinct invoices. An invoice counts once in total,
                            and once in each part it has alerts in.
                        topic_count:
                          type: integer
                          description: >-
                            Distinct topics. A topic counts once in total, and
                            once in each part it has alerts in.
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - invoice_count
                        - topic_count
                        - impact_by_currency
                  required:
                    - credited
                    - uncredited
                accepted:
                  type: object
                  properties:
                    credited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        invoice_count:
                          type: integer
                          description: >-
                            Distinct invoices. An invoice counts once in total,
                            and once in each part it has alerts in.
                        topic_count:
                          type: integer
                          description: >-
                            Distinct topics. A topic counts once in total, and
                            once in each part it has alerts in.
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - invoice_count
                        - topic_count
                        - impact_by_currency
                    uncredited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        invoice_count:
                          type: integer
                          description: >-
                            Distinct invoices. An invoice counts once in total,
                            and once in each part it has alerts in.
                        topic_count:
                          type: integer
                          description: >-
                            Distinct topics. A topic counts once in total, and
                            once in each part it has alerts in.
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - invoice_count
                        - topic_count
                        - impact_by_currency
                  required:
                    - credited
                    - uncredited
                dismissed:
                  type: object
                  properties:
                    credited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        invoice_count:
                          type: integer
                          description: >-
                            Distinct invoices. An invoice counts once in total,
                            and once in each part it has alerts in.
                        topic_count:
                          type: integer
                          description: >-
                            Distinct topics. A topic counts once in total, and
                            once in each part it has alerts in.
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - invoice_count
                        - topic_count
                        - impact_by_currency
                    uncredited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        invoice_count:
                          type: integer
                          description: >-
                            Distinct invoices. An invoice counts once in total,
                            and once in each part it has alerts in.
                        topic_count:
                          type: integer
                          description: >-
                            Distinct topics. A topic counts once in total, and
                            once in each part it has alerts in.
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - invoice_count
                        - topic_count
                        - impact_by_currency
                  required:
                    - credited
                    - uncredited
              required:
                - pending
                - accepted
                - dismissed
              description: >-
                Alerts by verdict, each split into credited and uncredited
                alerts. Credited amounts are alert impact, not recorded refunds.
          required:
            - total
            - by_verdict
      required:
        - id
        - agreement
        - suppliers
        - title
        - status
        - creator
        - created_at
        - updated_at
        - refund_summary
        - summary
    Error_validation_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_invalid_token:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_token
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
                - token_disabled
                - organization_required
                - insufficient_role
                - mfa_required
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_not_found:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_conflict:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - conflict
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_rate_limit_exceeded:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - rate_limit_exceeded
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_internal_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - internal_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_service_unavailable:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - service_unavailable
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      description: >-
        Personal API key sent as a bearer token, together with
        X-Organization-Id. The key must have at least the access level the
        endpoint requires (read, write or admin).

````