PATCH/api/v1/projects/<PROJECT_ID>/artboards/<ARTBOARD_ID>
Updates an existing artboard. Only provided fields are changed; omitted fields remain the same. The artboard ID cannot be modified.
Authentication
Request
- Method: PATCH
- URL:
/api/v1/projects/<PROJECT_ID>/artboards/<ARTBOARD_ID>
Parameters
name
string Artboard name.
type
"color""image""osm"Background source.
embedding_url
string Public URL for embedding.
image_url
string Background image URL (for type="image").
width
number Artboard width in px.
height
number Artboard height in px.
bg_color
string Background color hex.
osm_lat
number OSM latitude (for type="osm").
osm_lng
number OSM longitude (for type="osm").
osm_zoom
number OSM zoom level. Min 1.
Objects on the artboard.
Response
200 OK: The updated Artboard object.400 Bad Request: Validation failed. Returns a formatted error message.401 Unauthorized: API key is missing or invalid.404 Not Found: Project or artboard not found, or not accessible by the user.500 Internal Server Error: Failed to update Artboard.