PATCH/api/v1/projects/<PROJECT_ID>/artboards/<ARTBOARD_ID>/objects/<ID>
Updates an existing object on the specified artboard. Only provided fields are changed; omitted fields remain the same. The object ID cannot be modified.
Authentication
Request
- Method: PATCH
- URL:
/api/v1/projects/<PROJECT_ID>/artboards/<ARTBOARD_ID>/objects/<OBJECT_ID>
Parameters
name
string Object name.
type
"spot""poly"Geometry type.
click_action
"none""follow-link""change-artboard"Click behavior.
open_link_in_new_tab
boolean Open links in a new tab.
click_action_url
string Target URL for follow-link.
click_action_artboard_id
string Artboard ID for change-artboard.
x
number X coordinate (for type="spot").
y
number Y coordinate (for type="spot").
coords
{ x:number, y:number } []Vertices (for type="poly").
radius
number Spot radius.
pin
boolean Show pin marker.
color
string Fill color.
opacity
number Fill opacity.
stroke_color
string Stroke color.
stroke_width
number Stroke width.
stroke_opacity
number Stroke opacity.
hover_color
string Hover fill color.
hover_opacity
number Hover fill opacity.
hover_stroke_color
string Hover stroke color.
hover_stroke_width
number Hover stroke width.
hover_stroke_opacity
number Hover stroke opacity.
blend_mode
"inherit""normal""add""multiply""screen""darken""lighten""erase""color-dodge""color-burn""linear-burn""linear-dodge""linear-light""hard-light""soft-light""pin-light""difference""exclusion""overlay""saturation""color""luminosity""normal-npm""add-npm""screen-npm""none""subtract""divide""vivid-light""hard-mix""negation""min""max"Blend mode.
Response
200 OK: The updated Object.400 Bad Request: Validation failed. Returns a formatted error message.401 Unauthorized: API key is missing or invalid.404 Not Found: Project, artboard, or object not found, or not accessible by the user.500 Internal Server Error: Failed to update Object.