PATCH
/api/v1/projects/<PROJECT_ID>/popups/<POPUP_ID>

Updates an existing popup. Only provided fields are changed; omitted fields remain the same. The popup ID cannot be modified.


Authentication

Request

  • Method: PATCH
  • URL: https://api.markerkit.com/v1/projects/<PROJECT_ID>/popups/<POPUP_ID>

Parameters

name string
Popup name.
attachedTo string
ID of the object this popup is attached to.
maxWidth number
Max width in px.
title string
Popup title.
image string
Image URL.
content string
HTML/text content.
buttonText string
Button label.
buttonAction
"follow-link""none"
Button behavior.
buttonLink string
Target URL when buttonAction="follow-link".
openLinkInNewTab boolean
Open link in a new tab.

Response

  • 200 OK: The updated Popup object.
  • 400 Bad Request: Validation failed. Returns a formatted error message.
  • 401 Unauthorized: API key is missing or invalid.
  • 404 Not Found: Project or popup not found, or not accessible by the user.
  • 500 Internal Server Error: Failed to update Popup.

Example Request

Example Response