> ## 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.

# Updates a custom asset. Send only the fields you want to change.

> An omitted field is left alone, and re-sending a value the asset already holds is a no-op
rather than an error. Sending nothing at all is a 400.
            
`Description`, `ContactId`, `WarrantyEndDate`, `WarrantyStartDate`,
`Manufacturer`, `Model`, `IpAddress` and `SerialNumber` are cleared by
sending them as null. `WarrantyStartDate`, `Manufacturer` and `Model` are kept
for API callers only: the Gorelo app does not show them, and changing only those records
nothing on the asset's timeline. `Name`, `LocationId` and
`HardwareTypeId` cannot be cleared; null leaves them unchanged.
            
A new `ClientId` moves the asset to that client. The asset's location and contact
must belong to the new client, so send a `LocationId` of the new client, and a
`ContactId` of it or null, unless the ones the asset holds already belong to it.
            
The primary contact is also listed under the asset's related items: assigning a contact
adds it there, and replacing or clearing it removes the previous one.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/assets/custom/{customAssetId}
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/assets/custom/{customAssetId}:
    patch:
      tags:
        - Assets
      summary: Updates a custom asset. Send only the fields you want to change.
      description: "An omitted field is left alone, and re-sending a value the asset already holds is a no-op\r\nrather than an error. Sending nothing at all is a 400.\r\n            \r\n`Description`, `ContactId`, `WarrantyEndDate`, `WarrantyStartDate`,\r\n`Manufacturer`, `Model`, `IpAddress` and `SerialNumber` are cleared by\r\nsending them as null. `WarrantyStartDate`, `Manufacturer` and `Model` are kept\r\nfor API callers only: the Gorelo app does not show them, and changing only those records\r\nnothing on the asset's timeline. `Name`, `LocationId` and\r\n`HardwareTypeId` cannot be cleared; null leaves them unchanged.\r\n            \r\nA new `ClientId` moves the asset to that client. The asset's location and contact\r\nmust belong to the new client, so send a `LocationId` of the new client, and a\r\n`ContactId` of it or null, unless the ones the asset holds already belong to it.\r\n            \r\nThe primary contact is also listed under the asset's related items: assigning a contact\r\nadds it there, and replacing or clearing it removes the previous one."
      operationId: patch_v1_assets_custom_customAssetId
      parameters:
        - name: customAssetId
          in: path
          description: Custom asset to update.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Fields to change.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateCustomAssetCommand'
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomAssetCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomAssetCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateCustomAssetCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UpdateCustomAssetResultBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomAssetResultBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomAssetResultBaseResponse'
        '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'
        '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:
    UpdateCustomAssetCommand:
      type: object
      properties:
        Name:
          type: string
          description: >-
            Display name of the asset. Max 300 characters, cannot be blank. Null
            leaves it unchanged.
          nullable: true
          example: Reception printer
        ClientId:
          type: integer
          description: "Identifier of the client the asset belongs to; must be an active client. A different client\r\nmoves the asset, and its location and contact must then belong to the new client. Null\r\nleaves it unchanged."
          format: int64
          nullable: true
          example: 3521
        LocationId:
          type: integer
          description: "Identifier of the client location the asset sits at; must be an active location of the\r\nasset's client. Null leaves it unchanged."
          format: int64
          nullable: true
          example: 4410
        HardwareTypeId:
          type: integer
          description: "Identifier of the asset's hardware type, one of the service provider's active custom asset\r\ntypes. Null leaves it unchanged."
          format: int64
          nullable: true
          example: 118
        Description:
          type: string
          description: Free-text description, max 1000 characters. Send null to clear it.
          nullable: true
          example: HP LaserJet on the front desk
        ContactId:
          type: integer
          description: "Identifier of the contact the asset is assigned to; must be an active contact of the asset's\r\nclient. Send null to unassign it."
          format: int64
          nullable: true
          example: 7962
        WarrantyEndDate:
          type: string
          description: >-
            Date the warranty ends, a calendar date in the form yyyy-MM-dd. A
            value with a time or a time zone is rejected. Send null to clear it.
          format: date
          nullable: true
          example: '2027-03-31'
        LocalIPAddress:
          type: string
          description: >-
            IPv4 address of the asset, such as 192.168.1.20. Send null to clear
            it. The same name an agent asset publishes.
          nullable: true
          example: 192.168.1.20
        IpAddress:
          type: string
          description: "IPv4 address of the asset. Send null to clear it. <b>Deprecated:</b> use `LocalIPAddress`.\r\nStill accepted; sending both with different values is a 400."
          nullable: true
          example: 192.168.1.20
          deprecated: true
        SerialNumber:
          type: string
          description: Hardware serial number, max 250 characters. Send null to clear it.
          nullable: true
          example: CNB1K23456
        WarrantyStartDate:
          type: string
          description: >-
            Date the warranty starts, a calendar date in the form yyyy-MM-dd. A
            value with a time or a time zone is rejected. Send null to clear it.
          format: date
          nullable: true
          example: '2024-03-31'
        Manufacturer:
          type: string
          description: Manufacturer, max 300 characters. Send null to clear it.
          nullable: true
          example: Ubiquiti
        Model:
          type: string
          description: Model, max 300 characters. Send null to clear it.
          nullable: true
          example: UniFi Dream Machine Pro
      additionalProperties: false
      description: "Request body for updating a custom asset. Every field is optional - send only what should\r\nchange. An omitted field keeps the value the asset already holds."
    UpdateCustomAssetResultBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          $ref: '#/components/schemas/UpdateCustomAssetResult'
        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
    UpdateCustomAssetResult:
      type: object
      properties:
        Id:
          type: string
          format: uuid
      additionalProperties: false
      description: The identifier of the updated custom asset.
    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.