Update Asset

patch

https://preview.threekit.com/api/v2/assets/{assetId}

Updates an asset by ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

assetId

string

required

ID of the asset to be retrieved. This can either be the Threekit UUID or the user defined customId.

Query Params

bearer_token

string

Private token used to authorize the request. This endpoint is only accessible using a private token.

branch

string

Name of the org branch to connect to. If no value is provided the default value is "main".

Body Params

Asset update information.

name

string

Asset name.

description

string

Asset description

tags

attributes

array

attributes

metadata

array

Asset metadata

metadata

keywords

array of strings

keywords

publicShare

boolean

Whether share the asset to public or not

parentFolderId

string

ID of the folder to move asset to. Root folder values are- 1. Catalog items and Stages - 'catalog' 2. Assets and Global Attributes - 'assets'

publishedAt

string

Time when asset was published

defaultStageId

string

ID of the asset stage

defaultCompositeId

string

ID of the asset composite

customId

string

A custom identifier that the user can use as reference instead of the Threekit generated UUID. It cannot be longer than 255 characters and cannot be a UUID. It is unique within the scope of the org.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns catalog item information

401User is not authenticated. They must be authenticated to use this service.

403The token being used does not belong to the org being queried or does not have enough permissions to make the request.

404No asset was found for the given ID

422The request body was missing required fields or contained invalid fields.