Set Alt Text (Designer API v2) — Webflow API Documentation

`asset.setAltText(altText, localeId?)`

This method sets the Alt Text for a specific Asset.

Syntax

1 asset.setAltText(altText: string | null; localeId?: string): Promise<null>

Parameters

altText: string - The alt text for the Asset. If null is passed as this parameter, Webflow will set the asset alt text to “decorative.”
localeId string (optional) - The Locale ID for the Alt Text.

Returns

Promise<null>

A Promise that resolves to null.

Example

1 // Get Asset by ID
2 const asset = await webflow.getAssetById(assetId)
3 console.log(asset)
4 
5 if (asset) {
6   // Get asset URL
7   const originalAltText = await asset.getAltText()
8   await asset.setAltText(altText)
9   const newAltText = await asset.getAltText()
10   console.log(`Original Asset Alt Text: ${originalAltText}`)
11   console.log(`New Asset Alt Text: ${newAltText}`)
12 }

Designer Ability

Checks for authorization only

Designer Ability	Locale	Branch	Workflow	Sitemode
canAccessAssets	any	any	any	any

1	// Get Asset by ID
2	const asset = await webflow.getAssetById(assetId)
3	console.log(asset)
4
5	if (asset) {
6	// Get asset URL
7	const originalAltText = await asset.getAltText()
8	await asset.setAltText(altText)
9	const newAltText = await asset.getAltText()
10	console.log(`Original Asset Alt Text: ${originalAltText}`)
11	console.log(`New Asset Alt Text: ${newAltText}`)
12	}