assets

Update an asset

Partial update of the descriptive fields: name, altText, tags, metadata, status, width and height. The URL and content type of an asset cannot change; create a new asset instead.

Errors

  • 404 NOT_FOUND: no asset with this id in the active Space.
  • 400 VALIDATION_ERROR: the body failed validation; details.issues[] names each field.
put/api/v1/assets/{id}

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/assets/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The asset id.

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Request body

namestring

Display name.

altTextstring

Alternative text describing the image.

tagsstring[]

Free-form tags.

metadataobject

Anything else you want to keep with the asset.

status'PROCESSING' | 'READY' | 'FAILED'

Processing state.

widthinteger

Width in pixels.

heightinteger

Height in pixels.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.