Update an existing asset.

put

https://example.com/authoring/v1/assets/{id}

Use this end-point to update an existing asset that matches the ID that is specified. A conditional request is supported. Note:- If AI tag analysis is enabled, it starts in the background. AI analyzes and provides tag recommendations for the asset that is created.
User roles: admin, manager, editor

Path Params

string

required

Provide the ID of the asset that you want to update.

Query Params

fields

array of strings

Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default.

fields

include

array of strings

Optional: Parameters used to include additional fields inside each returned asset. Use "links" to include the links section, which contains URLs for actions that can be performed on the asset. Use "metadata" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, "include=links,metadata".

include

forceOverride

boolean

Defaults to false

Specifies whether revision checking should be disabled.

Body Params

Provide all the data that you want to update in this asset. The resource data that you provided is validated. If you change the resource of the asset with a new resource, it must not cause any changes to the asset. The path that you provide must contain a leading slash and must be unique and unchanged. The path and name fields are optional and are generated from the resource’s name by default.

resource

string

required

name

string

path

string

description

string

200Successfully updated the asset that matches the ID that you provided.

400The required parameters are missing or invalid, or the number of allowed assets have been reached. Please read the error message and alter the request accordingly.

409The asset was updated by another user whilst you tried to update it. Please review the latest version before retrying.

412The Etag provided in the If-Match header does not correspond to the latest version.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.

503Connection failed to data store.

defaultUnexpected error.