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

# Update

> Update asset metadata

CLI: `adside assets update`



## OpenAPI

````yaml /api-reference/openapi.yaml patch /v1/workspaces/{workspaceId}/assets/{assetId}
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/assets/{assetId}:
    patch:
      tags:
        - Assets
      summary: Update
      description: |-
        Update asset metadata

        CLI: `adside assets update`
      operationId: assets.update
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: assetId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                description:
                  type: string
                  maxLength: 1000
                category:
                  type: string
                  enum:
                    - UNKNOWN
                    - LOGO
                    - PRODUCT
                    - LIFESTYLE
                    - BANNER
                    - ICON
                    - BACKGROUND
                    - SCREENSHOT
                    - AD_CREATIVE
                    - OTHER
                tags:
                  maxItems: 50
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 60
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  asset:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        anyOf:
                          - type: string
                          - type: 'null'
                      description:
                        anyOf:
                          - type: string
                          - type: 'null'
                      url:
                        anyOf:
                          - type: string
                          - type: 'null'
                      mimeType:
                        type: string
                      fileSize:
                        type: number
                      width:
                        anyOf:
                          - type: number
                          - type: 'null'
                      height:
                        anyOf:
                          - type: number
                          - type: 'null'
                      status:
                        type: string
                        enum:
                          - PENDING
                          - PROCESSING
                          - READY
                          - FAILED
                          - ARCHIVED
                          - PENDING_DELETION
                      sourceType:
                        type: string
                        enum:
                          - SCRAPED
                          - UPLOADED
                          - GENERATED
                          - DERIVED
                          - GOOGLE_DRIVE
                          - CANVA
                          - FIGMA
                          - META_AD
                          - PLATFORM_IMPORT
                          - SLACK
                      category:
                        type: string
                        enum:
                          - UNKNOWN
                          - LOGO
                          - PRODUCT
                          - LIFESTYLE
                          - BANNER
                          - ICON
                          - BACKGROUND
                          - SCREENSHOT
                          - AD_CREATIVE
                          - OTHER
                      tags:
                        type: array
                        items:
                          type: string
                      createdAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      workspaceId:
                        type: string
                      sourceMetadata:
                        anyOf:
                          - {}
                          - type: 'null'
                      derivedFromId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      createdById:
                        anyOf:
                          - type: string
                          - type: 'null'
                      updatedAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      platformAssetReferences:
                        default: []
                        type: array
                        items:
                          type: object
                          properties:
                            platform:
                              type: string
                            externalAccountId:
                              type: string
                            externalAssetId:
                              type: string
                            externalName:
                              anyOf:
                                - type: string
                                - type: 'null'
                          required:
                            - platform
                            - externalAccountId
                            - externalAssetId
                            - externalName
                          additionalProperties: false
                    required:
                      - id
                      - name
                      - description
                      - url
                      - mimeType
                      - fileSize
                      - width
                      - height
                      - status
                      - sourceType
                      - category
                      - tags
                      - createdAt
                      - workspaceId
                      - sourceMetadata
                      - derivedFromId
                      - createdById
                      - updatedAt
                      - platformAssetReferences
                    additionalProperties: false
                required:
                  - asset
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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