updateArtboard()

Updates properties of an existing artboard by its ID. Validates the changes against the schema and updates width and height if a new image URL is provided.

Signature


Parameters

id string
The ID of the artboard to update.
options Artboard (partial)
The properties to update. Only the specified fields will be changed. The id cannot be modified. If image_url is set, width and height are updated based on the image’s natural size.

Returns

A Promise that resolves to the updated Artboard, or null if the project has no artboards, the artboard is not found, or validation fails.

Example