Skip to main content
New to Corsair? See API access, authentication, and error handling.

Bee Plugin

suspendUser

beePlugin.suspendUser Suspend or reinstate a Bee Plugin user Risk: write
Input Output

userImages

beePlugin.userImages List the images one Bee Plugin user made over a window Risk: read
Input Output

users

beePlugin.users List Bee Plugin users with their image and open counts over a window Risk: read
Input Output

Images

delete

images.delete Delete an image or timer by URL; emails that embed it stop showing it Risk: destructive · Irreversible
Input Emails that embed the image stop showing it. Output

get

images.get Read one image or timer by its URL: type, opens, dates and whether it is active Risk: read
Input Output

list

images.list Page through every personalized image and countdown timer in the account Risk: read
Input Output

stats

images.stats Opens per image over a date range (the last 30 days by default) Risk: read
Input Output

Maps

addLocation

maps.addLocation Add a location to a map by address or coordinates, with custom properties Risk: write
Input Address maps take Address; latitude/longitude maps take Latitude and Longitude. Geocoding runs in the background.
Output

deleteLocation

maps.deleteLocation Remove a location from a map Risk: destructive · Irreversible
Input Output

get

maps.get Read one map: how many locations are searchable, failed or queued, plus opens and clicks Risk: read
Input Output

list

maps.list List the map images in the account with their opens Risk: read
Input: empty object Output

searchLocations

maps.searchLocations Find locations in a map by address, location id, NiftyID or latitude and longitude Risk: read
Input Output

updateLocation

maps.updateLocation Change a map location found by NiftyID or location id Risk: write
Input
Output

Psd

get

psd.get Read a Photoshop image: its text variables and every layer with its type and settings Risk: read
Input Output

update

psd.update Change a Photoshop image: rename it, set variable defaults, or edit layers by name (text, colours, images, visibility) Risk: write
Input
Output

Store

addRecord

store.addRecord Add a Data Store record, or update the one whose unique fields match Risk: write
Input Updates the existing record when its unique fields match; keys that are not Data Store fields are ignored. Output

deleteById

store.deleteById Delete a Data Store record by its id (the value of its unique field) Risk: destructive · Irreversible
Input Output

deleteRecord

store.deleteRecord Delete the Data Store record whose unique fields match the ones given Risk: destructive · Irreversible
Input Output

fields

store.fields List the Data Store fields with their types and which ones are unique Risk: read
Input: empty object Output

Timers

updateTargetDate

timers.updateTargetDate Move a countdown timer to a new target date, optionally shifted by hours, days or months Risk: write
Input Output

Widgets

images

widgets.images List the images a widget generated in a time window, with each image’s URL and own counts Risk: read
Input Output

list

widgets.list List the account’s widgets with their names and keys, which every other widget call needs Risk: read
Input Answers a bare array of widgets with Name and WidgetKey, which the plugin keys as widgets. Output

stats

widgets.stats Read per-widget user, image and impression counts for a time window, for every widget at once Risk: read
Input Reads AllStats, so one call covers every widget. Output

suspendUser

widgets.suspendUser Suspend or reinstate a widget user Risk: write
Input Output

userImages

widgets.userImages List the images a widget generated for one recipient Risk: read
Input Output

users

widgets.users List the users one widget recorded in a time window, with their image and impression counts and whether they are suspended Risk: read
Input Output

userStats

widgets.userStats Read aggregated stats for one recipient of one widget Risk: read
Input The user is percent-encoded into the path, because it is usually an email address. Output