POST
/api/v1/projects/<PROJECT_ID>/popups

Creates a new popup in the specified project. The popup ID is server-generated; omitted fields use schema defaults.


Authentication

Request

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

Parameters

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

Response

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

Example Request

Example Response