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

# Edit an asset

> `AssetID` is required. Other fields are optional.

Ordinary field edits are blocked when the asset is Delivered. `LabelID` can be changed only while the asset is Created. Assigning a label moves the asset to Ready. Send only the fields you intend to update.

To mark an asset delivered, end tracking, or end tracking and expire it, see the delivery and tracking guide.



## OpenAPI

````yaml /openapi/openapi.json put /Assets/EditAsset
openapi: 3.1.0
info:
  title: Aiyoti Integration API Basic
  description: Create, retrieve, update, and manage the tracking lifecycle of assets.
  version: 0.0.1
servers:
  - url: https://api.aiyoticloud.com
security: []
tags:
  - name: Users
    description: Log in and refresh credentials.
  - name: Carriers
    description: Look up the carriers available to an account.
  - name: Labels
    description: Look up the labels available for new assets.
  - name: Assets / Shipments
    description: Create, list, retrieve, edit, annotate, and delete assets.
paths:
  /Assets/EditAsset:
    put:
      tags:
        - Assets / Shipments
      summary: Edit an asset
      description: >-
        `AssetID` is required. Other fields are optional.


        Ordinary field edits are blocked when the asset is Delivered. `LabelID`
        can be changed only while the asset is Created. Assigning a label moves
        the asset to Ready. Send only the fields you intend to update.


        To mark an asset delivered, end tracking, or end tracking and expire it,
        see the delivery and tracking guide.
      operationId: edit_asset_Assets_EditAsset_put
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditAsset'
            examples:
              edit:
                summary: Change name and description
                value:
                  AssetID: '00000000000000000000000000000003'
                  AssetName: Updated Shipment
                  Description: Updated shipment description
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutationResult'
              example:
                Code: 200
                Message: Success
        '422':
          description: Request validation failed. Check required fields and value types.
      security:
        - accessKey: []
components:
  schemas:
    EditAsset:
      properties:
        AssetID:
          type: string
          description: Unique identifier of the asset.
        AccountID:
          anyOf:
            - type: string
            - type: 'null'
          description: Unique identifier of the account.
        CarrierID:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Unique identifier of the carrier. Use a valid carrier identifier if
            you supply this field.
        AssetName:
          anyOf:
            - type: string
            - type: 'null'
          description: Name of the asset.
        TrackingNo:
          anyOf:
            - type: string
            - type: 'null'
          description: Carrier tracking number.
        LabelID:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Label identifier. Optional on creation and can be omitted. Send it
            as a string in requests. Responses return `LabelID` as a number.
        GroupID:
          anyOf:
            - type: string
            - type: 'null'
          description: Unique identifier of the group.
        DestinationAddress:
          anyOf:
            - type: string
            - type: 'null'
          description: Destination address.
        DestinationLat:
          anyOf:
            - type: number
            - type: 'null'
          description: Destination latitude.
        DestinationLng:
          anyOf:
            - type: number
            - type: 'null'
          description: Destination longitude.
        Description:
          anyOf:
            - type: string
            - type: 'null'
          description: Free-text description.
        EnableTracking:
          anyOf:
            - type: integer
            - type: 'null'
          description: Send `0` to end tracking.
        AssetStatus:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Status value. `5` marks the asset Delivered; `9` expires it. See the
            status table in the delivery and tracking guide.
        ExcRisk:
          anyOf:
            - type: integer
            - type: 'null'
          description: Omit this field for Basic integrations.
        Context:
          anyOf:
            - type: string
            - type: 'null'
          description: Omit this field for Basic integrations.
        AssetForeignID:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Identifier supplied by your system. Not included in the list
            response.
      type: object
      required:
        - AssetID
    MutationResult:
      type: object
      properties:
        Code:
          type: integer
          description: >-
            Application code in the response body. Separate from the HTTP
            status.
        Message:
          type: string
          description: Result message.
      description: Response body for successful asset changes.
  securitySchemes:
    accessKey:
      type: apiKey
      in: header
      name: AccessKey
      description: >-
        Send the `access` token returned by Login. Both `access` and `refresh`
        tokens are accepted; reserve `refresh` for credential renewal.

````

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