Sign in

v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Assets

Archives the asset.

Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can restore them.

post/assets/v1/assets/{assetId}:archive

Path parameters

assetIdstring required

The unique identifier of the asset.

Response

Asset archived succesfully successfully.

assetTypestring enum

The asset type. Required for Create Asset.

assetIdinteger

The unique identifier of the asset. Required for Update Asset.

descriptionstring

The description of the asset. Limit to 1000 characters. Required for Create Asset.

displayNamestring

Display name of the asset. Required for Create Asset.

pathstring

The returned resource path of the asset. Format: assets/{assetId}. Example: assets/2205400862.

revisionIdstring

Revision ID of the asset. Equivalent to versionNumber. Every change of the asset automatically commits a new version. The format is an integer string. Example: 1.

revisionCreateTimestring date-time

The creation timestamp of the current revision.

iconstring

The resource path for the icon.

state'Unspecified' | 'Active' | 'Archived'

Whether the asset is active or archived. Unspecified isn't used.