Flipsnack

Create a new Flipsnack flipbook collection, optionally importing a PDF from a URL. Returns the full collection detail including its hash, direct link, and (after processing) the contained flipbooks. Beyond the core fields it accepts the same customize options as collection_update (player look & feel, controls, background color, auto-flip, analytics, password, etc.) — the create endpoint applies them via the same update handler internally. Image/logo/audio file assets cannot be set here (they require a file upload). This is a write operation that creates new content on the user's account.

collection_create

Move a flipbook collection to the Flipsnack trash. This is NOT a permanent delete — the collection can still be restored from the trash UI. Use only when the user explicitly asks to delete or remove a collection. Returns a confirmation with the hash that was trashed.

collection_delete

Fetch account-wide analytics aggregated across every collection owned by the authenticated user: total impressions, views, shares and downloads, average time spent per view, and the remaining API upload quota for the current billing period. Read-only and takes no parameters. For per-collection breakdowns use collection_get_stats.

user_get_stats

Fetch the full detail of one specific Flipsnack collection by its hash. Use this after collection_get_list (or when the user already has a hash) to retrieve every field: title, description, status, cover image, direct link, contained flipbooks, settings, and publish date. Read-only.

collection_get_collection

Read the reader-access (permissions) configuration of a PRIVATE collection. Returns the list of permission entries, each with a type (teammate / user / otp / sso) and optionally an email or group. Only works for a collection that is published, has visibility "private", and has NO password set — otherwise the API returns a "permissions not eligible" error. Read-only.

collection_get_permissions

Fetch interaction statistics for one individual reader on a single flipbook collection. Identify the reader by exactly one of: readerEmail, otpEmail, ssoViewerId, trackableLinkHash, or linkId. Returns summary counters and optional page breakdown, link clicks, and session details. Read-only.

collection_get_reader_stats

Fetch reader analytics for a single flipbook collection: impressions, views, total time spent, downloads, and an optional per-page breakdown. Optionally restrict the report to a date range. Use when the user asks how a specific publication is performing. Read-only. For account-wide totals across every collection, use user_get_stats instead.

collection_get_stats

Generate the HTML iframe snippet used to embed a Flipsnack collection on a third-party website. Use this when the user wants to put a flipbook on their own page or blog. You can optionally specify pixel width/height or request a responsive iframe that scales to its container. Read-only — the call does not modify the collection.

collection_get_embed

List the authenticated user's flipbook collections, with optional filtering by status, folder, or free-text query, plus pagination. Use this when the user asks to browse, find, or search their existing collections. Returns an array of summary records (hash, title, status, cover image, direct link); use collection_get_collection to fetch full detail for one.

collection_get_list

Queue a “send by email” share for a collection. Branding (logo, colors, footer) comes from the workspace Brand Identity send-email settings — do not pass branding fields. Success means the emails were queued for asynchronous delivery, not that they were delivered. The collection must be PUBLISHED, have visibility "public" or "unlisted", and have NO password set; anything else is rejected as forbidden. Recipient handling — the API parses `recipients` and treats the two failure kinds differently: - Addresses it cannot parse are dropped and returned in `invalidRecipients` while the valid ones are still sent. Only when NOT ONE address is valid does the whole call fail. So check `invalidRecipients` on success to spot a partial send. - Sending to more than one recipient requires the workspace plan feature; the check counts valid addresses only. Daily quota (100, or 1000 with the multi-recipient feature) is applied per workspace and also partially: if the request would exceed the remaining quota, the API queues as many as fit and returns the rest in `skippedRecipients`. It fails outright only when nothing fits. A workspace can send only one batch every couple of seconds, so a rapid second call is rejected — wait and retry.

collection_send_email