Popups

The popups resource has full RUD functionality. It allows you to Retrieve, Update and Delete popups. The following actions can be performed on this resource...

Retrieve All Popups

Retrieves all popups associated with a specific brand.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/website-popups

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will return only inactive popups.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/website-popups?active=0

Example Response:

{ "data": [ { "website_popup_id": 7, "_brand_id": 3, "name": "My Popup", "description": "This was created from a template", "min_page_views": 1, "show_event": "load", "show_delay_seconds": 0, "show_inactivity_seconds": 0, "show_scroll_percent": 0, "show_scroll_text": null, "hide_from_known_contacts": 1, "start_minimized": 0, "reopen_value": 30, "reopen_unit": "day", "url_show_rules": null, "url_hide_rules": null, "show_date": null, "hide_date": null, "show_desktop": 1, "show_tablet": 1, "show_mobile": 1, "html_build": "HTML", "html_display": "HTML", "website_preview_url": null, "double_opt_in_message": "To complete your subscription to SlickText text alerts, reply YES.", "opt_in_message": "Thanks for subscribing to SlickText text alerts.", "opt_in_message_media_url": null, "active": 0, "created": "2024-11-22 19:04:30", "last_updated": "2024-11-22 19:04:53", "deleted": null } ], "pagingData": { "prevPage": null, "currentPage": null, "nextPage": null, "currentPageString": null, "hasMore": false } }

Retrieve a Specific Popup

Retrieves a single popup with the Popup ID equal to {id}. The Popup ID can be found using the retrieve all popups endpoint.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/website-popups/{{id}}

Example Response:

{ "website_popup_id": 7, "_brand_id": 3, "name": "My Popup", "deleted": null, "description": "This was created from a template", "min_page_views": 1, "show_event": "load", "show_delay_seconds": 0, "show_inactivity_seconds": 0, "show_scroll_percent": 0, "show_scroll_text": null, "hide_from_known_contacts": 1, "start_minimized": 0, "reopen_value": 30, "reopen_unit": "day", "url_show_rules": null, "url_hide_rules": null, "show_date": null, "hide_date": null, "show_desktop": 1, "show_tablet": 1, "show_mobile": 1, "html_build": "HTML", "html_display": "HTML", "website_preview_url": null, "double_opt_in_message": "To complete your subscription to SlickText text alerts, reply YES.", "opt_in_message": "Thanks for subscribing to SlickText text alerts.", "opt_in_message_media_url": null, "active": 0, "created": "2024-11-22 19:04:30", "last_updated": "2024-11-22 19:04:53" }

Edit a Specific Popup

Allows you to edit existing popups. You can target an existing popup by passing the popup ID in your PUT request. The Popup ID can be found using the retrieve all popups endpoint.

PUT https://dev.slicktext.com/v1/brands/{{brand_id}}/website-popups/{{id}}

Arguments

PARAMETER DESCRIPTION
name Name of popup
description Description of popup
active 1 for active, 0 for inactive

Example Request Body:

{ "name": "Updated Popup", "description": "Updated description", "active": 0 }

Example Response:

{ "website_popup_id": 7, "_brand_id": 3, "deleted": null, "name": "Updated Popup", "description": "Updated description", "min_page_views": 1, "show_event": "load", "show_delay_seconds": 0, "show_inactivity_seconds": 0, "show_scroll_percent": 0, "show_scroll_text": null, "hide_from_known_contacts": 1, "start_minimized": 0, "reopen_value": 30, "reopen_unit": "day", "url_show_rules": null, "url_hide_rules": null, "show_date": null, "hide_date": null, "show_desktop": 1, "show_tablet": 1, "show_mobile": 1, "html_build": "HTML", "html_display": "HTML", "website_preview_url": null, "double_opt_in_message": "To complete your subscription to SlickText text alerts, reply YES.", "opt_in_message": "Thanks for subscribing to SlickText text alerts.", "opt_in_message_media_url": null, "active": 0, "created": "2024-11-22 19:04:30", "last_updated": "2024-11-22 19:04:53" }

Delete a Specific Popup

Deletes an existing popup with the Popup ID equal to {id}. The Popup ID can be found using the retrieve all popups endpoint. Using this action, the popup is simply removed completely from the brand.

DELETE https://dev.slicktext.com/v1/brands/{{brand_id}}/website-popups/{{id}}

Example Response:

[]