Developer API · REST

FlipLink API-referentie

Maak flipbooks & documenten aan, configureer de viewer, leg leads vast en beheer aangepaste domeinen — allemaal programmatisch. Authenticeer met je API-sleutel en probeer elk endpoint live uit, rechtstreeks vanaf deze pagina.

Base URL https://go.fliplink.me

Haal een sleutel op →

Inleiding

Met de FlipLink REST API kun je programmatisch flipbooks & documenten aanmaken en beheren — PDF's uploaden, de viewer configureren, leads vastleggen, aangepaste domeinen beheren en meer. Elk endpoint is bereikbaar onder de base URL hieronder en wordt geauthenticeerd met je API-sleutel.

Base URL
https://go.fliplink.me

Authenticatie

Stuur je API-sleutel bij elke aanvraag mee. Er worden twee headerstijlen ondersteund — gebruik degene die je HTTP-client het liefst heeft:

Auth-headers
X-Api-Key: YOUR_API_KEY
# — or —
Authorization: Bearer YOUR_API_KEY

Een ontbrekende of ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina “Unauthorized” — er is geen JSON-body, dus probeer er bij een 401 geen te parsen). Zodra de sleutel geldig is, komt elke andere fout terug als HTTP 200 met Result: ERROR (zie hieronder). Houd je sleutel geheim — zet hem nooit in client-side code die je naar eindgebruikers verstuurt.

Responsformaat & resultaattypes

Alle responsen zijn JSON en bevatten een Result-veld op het hoogste niveau — er zijn precies twee waarden:

  • "Result": "OK" — succes. Read-endpoints voegen hun payload toe; write-endpoints voegen een leesbaar Message toe (bijv. "Updated successfully") en create/duplicate geven de nieuwe ID en URL terug.
  • "Result": "ERROR" — mislukt, met een Message die uitlegt waarom.

Belangrijk: alleen auth-fouten (401), te grote uploads (413) en rate limiting (429) gebruiken een HTTP-status anders dan 200. Al het andere — validatie, “niet gevonden”, businessregels — geeft HTTP 200 met Result: ERROR terug, dus controleer Result, niet alleen de status.

Paginering

List-endpoints accepteren de queryparameters PageNo, PageSize en Offset. Laat ze weg voor zinvolle standaardwaarden.

Rate limits

Elke API-sleutel is beperkt tot 300 aanvragen per minuut. Het venster ligt vast en wordt op de klokminuut gereset (geen voortschrijdende 60 seconden). Elke respons bevat het huidige budget in zijn headers:

Rate-limit-headers
X-RateLimit-Limit: 300          # requests allowed per minute
X-RateLimit-Remaining: 287      # requests left in the current window
X-RateLimit-Reset: 1781962140   # Unix epoch (seconds) when the window resets

Als je de limiet overschrijdt, krijg je HTTP 429. Wacht tot X-RateLimit-Reset (of doe een back-off en probeer het opnieuw) en houd X-RateLimit-Remaining in de gaten om onder de limiet te blijven.

Planlimieten & quota

Je flipbookquotum wordt teruggegeven bij create-responsen en get-subscription-details als Flipbooks_Count / Flipbooks_Max / Flipbooks_Left. De maximale uploadgrootte staat in MaxFileSizeMB.

Fouten

Veelvoorkomende situaties die je moet afhandelen (elk endpoint somt hieronder ook zijn eigen op):

  • 401 — ontbrekende of ongeldige API-sleutel (HTML-pagina, geen JSON)
  • 413 — upload overschrijdt de maximale bestandsgrootte van het plan
  • 429 — rate limited; doe een back-off en probeer het opnieuw
  • 200 + Result:ERROR — al het andere: niet gevonden ("Item not found"), validatie ("Unknown field(s) …") of een businessregel ("This custom URL is already in use…", "File is not a valid PDF")

Profiel

Wie ben ik

Geeft het account terug waar de API-sleutel bij hoort — user-/vendor-ID's, naam, e-mailadres, merk, app-URL en de maximale uploadgrootte van het plan (MaxFileSizeMB).

GEThttps://go.fliplink.me/api/whoami

Vereisten — geen. Dit is de root-aanroep: hij authenticeert je API-sleutel, de vereiste voor elk ander endpoint.

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/whoami
curl -X GET 'https://go.fliplink.me/api/whoami' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Profiel ophalen

Geeft het accountprofiel bij de API-sleutel terug — weergavenaam, telefoonnummer en de URL van de profielafbeelding.

GEThttps://go.fliplink.me/api/get-profile
VereistenWie ben ik(een geldige API-sleutel)Profiel ophalen

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/get-profile
curl -X GET 'https://go.fliplink.me/api/get-profile' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Profiel instellen (gedeeltelijk)

Gedeeltelijke update — weggelaten velden houden hun bestaande waarde. Minstens één veld is verplicht.

PUThttps://go.fliplink.me/api/set-profile
VereistenWie ben ik(een geldige API-sleutel)Profiel instellen (gedeeltelijk)

Bodyparameters

Namebijv. Mark Stevens
Phonephonebijv. +14155550142
ProfileImageURLbijv. https://...

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GerelateerdProfiel ophalen
PUT/api/set-profile
curl -X PUT 'https://go.fliplink.me/api/set-profile' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Mark Stevens' \
  --data-urlencode 'Phone=+14155550142' \
  --data-urlencode 'ProfileImage=https://...'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Bodyparameters

Abonnement & betalingen

Abonnementsgegevens ophalen

Geeft je huidige plan en quotum terug — plannaam, status, kosten, datum van de volgende factuur, maximale bestandsgrootte, maximumaantal items/CNAME's en feature-flags.

GEThttps://go.fliplink.me/api/get-subscription-details
VereistenWie ben ik(een geldige API-sleutel)Abonnementsgegevens ophalen

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/get-subscription-details
curl -X GET 'https://go.fliplink.me/api/get-subscription-details' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Subscription": {
    "BrandName": "",
    "Name": "Your Account",
    "Mobile": "",
    "SubscriptionPlan": "LTD Individual",
    "SubscriptionFees": "USD 39.00",
    "Tax": "",
    "SubscriptionID": "#20000",
    "ActiveFrom": "12 Jun 2026",
    "Status": "Active",
    "NextInvoice": "01 Jan 2050",
    "Email": "you@example.com",
    "PhotoIMG": "/Content/assetsNew/media/avatars/blank.png",
    "MaxFileSizeBytes": 157286400,
    "MaxFileSize": "150",
    "MaxCNAME": "Unlimited",
    "AdvancedSharing": "Yes",
    "LeadEmailVerification": "Yes",
    "IsLTD": "Yes",
    "MaxItems": "200"
  }
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Betalingen weergeven

Geeft je facturatiegeschiedenis terug — elke aankoop/verlenging van een plan met order-ID, bedrag, plan, datum en aantal items.

GEThttps://go.fliplink.me/api/list-payments
VereistenWie ben ik(een geldige API-sleutel)Betalingen weergeven

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-payments
curl -X GET 'https://go.fliplink.me/api/list-payments' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "OrderID": "#10001",
      "Amount": "USD 39.00",
      "Plan": "LTD Individual / 822bf1b6",
      "Date": "12 Jun 2026",
      "DateIso": "2026-06-12T00:00:00+05:30",
      "InvoiceURL": "",
      "ItemCount": 100
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Items — aanmaken

Aanmaken via bestand

Maakt een flipbook (of document) aan op basis van een geüploade PDF, verzonden als multipart/form-data. Het bestand wordt opgeslagen, er wordt een thumbnail gegenereerd en het record wordt geregistreerd.

Opmerkingen
- Of je een Flipbook of een Document krijgt, wordt bepaald door de Host-header van de aanvraag — go.fliplink.me (standaard) geeft Flipbooks terug, go.doclink.me geeft Documenten terug.
- *_Count / *_Max / *_Left weerspiegelen je planquotum na deze aanmaak.
- Gebruik de teruggegeven ID voor vervolgaanroepen (set-meta, set-cta-primary, save-as-template, enzovoort).
- De maximale bestandsgrootte verschilt per plan (zie MaxFileSizeMB uit who-am-i).

POSThttps://go.fliplink.me/api/create-by-file
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand

Body (multipart/form-data)

Filefile
Namebijv. My Document
Titlebijv. My Title
DocTypeenumFlipbook of Document. Op go.doclink.me altijd als Document behandeld.Een van: Flipbook, Document

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

POST/api/create-by-file
curl -X POST 'https://go.fliplink.me/api/create-by-file' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file' \
  -F 'Name=My Document' \
  -F 'Title=My Title' \
  -F 'DocType=Flipbook'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Body (form-data)

Aanmaken via URL

Maakt een flipbook (of document) aan op basis van een PDF-URL. De server downloadt FileURL, uploadt die naar S3, genereert een thumbnail en registreert het record.

Opmerkingen
- Of de veldnaam het voorvoegsel Flipbooks_* of Documents_* krijgt, wordt bepaald door de Host-header van de aanvraag — go.fliplink.me (standaard) geeft Flipbooks terug, go.doclink.me geeft Documenten terug.
- *_Count / *_Max / *_Left weerspiegelen het planquotum van het account na deze aanmaak.
- De bron-URL moet binnen 60s reageren — trage of onbereikbare bronnen falen met Source URL timed out after 60s. Gebruik voor onbetrouwbare bronnen liever /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via URL

Bodyparameters

FileURLURLbijv. https://example.com/document.pdf
Namebijv. My Document
Titlebijv. My Title
DocTypeenumbijv. FlipbookEen van: Flipbook, Document

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200FileURL host is private / not allowed{ "Result": "ERROR", "Message": "FileURL host is not allowed." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

POST/api/create-by-url
curl -X POST 'https://go.fliplink.me/api/create-by-url' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FileURL=https://example.com/document.pdf' \
  --data-urlencode 'Name=My Document' \
  --data-urlencode 'Title=My Title' \
  --data-urlencode 'DocType=Flipbook'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Bodyparameters

Items — lezen

Eén ophalen

Geeft het volledige record van één flipbook/document op ID terug — elke opgeslagen kolom: titel, URL's, aantal views/leads/verkopen, map en statusvlaggen. Het volledige record wordt teruggegeven verpakt in een `Item`-object met ongeveer 190 kolommen; het voorbeeld hieronder is een ingekorte, representatieve selectie.

GEThttps://go.fliplink.me/api/get/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Eén ophalen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/get/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "Name": "My Document",
    "Title": "My Title",
    "DocType": "Flipbook",
    "IsPublished": true,
    "Pages": 8,
    "Folder": "Marketing",
    "SkinName": "Light Wood",
    "CustomURL": "my-document-96216",
    "ValidTillDate": "",
    "NoOfViews": 42,
    "NoOfLeads": 3,
    "NoOfSales": 0,
    "IsForSale": false,
    "IsLeadCapture": true,
    "IsPasswordProtected": false,
    "BookLayout": 1,
    "ScrollBehaviour": 1,
    "IsRightToLeft": false,
    "CoverType": "1",
    "PageDepth": "1",
    "FullURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172",
    "EmbedURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172"
  }
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Zoeken op URL

Zoekt een flipbook op via de openbare/share-URL en geeft het volledige record terug (zelfde vorm als get).

GEThttps://go.fliplink.me/api/find-by-url
VereistenWie ben ik(een geldige API-sleutel)Zoeken op URL

Queryparameters

URLURLVolledige viewer-URL, een CNAME-URL of alleen de kale CustomURL-slug. De server neemt het laatste padsegment als slug.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/find-by-url
curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https%3A%2F%2Fgo.fliplink.me%2Fview%2F%3Cslug%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "VendorID": "20000",
    "FilePDF": "/docs/20001/894abc58~demo_multipage.pdf",
    "Name": " coverage 20-Jun",
    "CreatedOn": "/Date(1781945608053)/",
    "NoOfViews": 1,
    "IsActive": true,
    "CustomURL": "your-flipbook-slug",
    "Title": "",
    "Description": " desc",
    "SkinID": -1,
    "LogoIMG": "",
    "LogoURL": "https://fliplink.me",
    "BackgroundIMG": "",
    "BackgroundDisplayFit": "",
    "BackgroundFillDirection": "",
    "ColorPanel": "#5A5F63",
    "ColorBackground": "#F2F2F2",
    "ColorLink": "#75869C",
    "FaviconIMG": "",
    "IsShare": true,
    "IsPrint": true,
    "IsDownload": false,
    "IsTextSelection": true,
    "IsThumbnails": true,
    "IsSound": false,
    "IsFullscreen": false,
    "IsZoom": false,
    "IsSearch": true,
    "IsPinnedThumbnails": false,
    "IsCTAButton": false,
    "CTAButtonText": "Buy",
    "CTAButtonColor": "#3366FF",
    "CTAButtonTextColor": "       ",
    "CTAButtonURL": "https://fliplink.me",
    "IsPasswordProtected": false,
    "Password": "",
    "IsLeadCapture": true,
    "LeadCaptureTitle": "",
    "IsLeadEmail": true,
    "IsLeadEmailMandatory": true,
    "IsLeadName": true,
    "IsLeadNameMandatory": false,
    "IsLeadPhone": false,
    "IsLeadPhoneMandatory": false,
    "IsLeadCompany": false,
    "IsLeadCompanyMandatory": false,
    "IsLeadDate": false,
    "IsLeadDateMandatory": false,
    "IsLeadCustom1": false,
    "IsLeadCustom1Mandatory": false,
    "Custom1Label": "",
    "IsLeadCustom2": false,
    "IsLeadCustom2Mandatory": false,
    "Custom2Label": "",
    "IsLeadPrivacyPolicy": false,
    "PrivacyPolicyURL": "",
    "IsLeadAllowSkip": true,
    "PageTurnMode": "Flip",
    "BookLayout": 1,
    "Shadowdepth": 1,
    "IsFixedZoomMode": false,
    "IsHardCover": false,
    "IsBookThickness": true,
    "IsLinkHighlight": true,
    "IsRightToLeft": false,
    "IMGPdf": "/Content/assets/media/users/no-image.png",
    "Pages": 8,
    "FacebookAnalyticsCode": "",
    "GoogleAnalyticsCode": "",
    "GoogleTagManager": "",
    "Folder": "-Folder",
    "PabblyWebhookURL_NewLead": "https://example.com/webhook-apitest",
    "TitleColor": "#3366FF",
    "CNAME": "",
    "IsNoIndex": false,
    "BackgroundMusic": "",
    "BackgroundMusicCustom": "",
    "AutoFlipInSecs": 0,
    "PwdTitle": "This is a private flipbook.\r\nTo view it, please enter the password.",
    "PwdPlaceholder": "Password",
    "PwdButton": "Submit",
    "LeadEmail": "Email",
    "LeadName": "Name",
    "LeadPhone": "Phone",
    "LeadCompany": "Company",
    "LeadDate": "Date",
    "LeadButton": "Submit",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsSendEmailOnView": false,
    "LeadFormAfterPages": 0,
    "CustomLoadingText": " loading",
    "IsShareButtons": true,
    "IsNotes": false,
    "IsCTAButton2": false,
    "CTAButtonText2": "More",
    "CTAButtonColor2": "#3366FF",
    "CTAButtonTextColor2": "       ",
    "CTAButtonURL2": "",
    "IsVerifyEmail": false,
    "IsVerifyMobile": false,
    "TwillioAPIKey": "",
    "IsShowControls": true,
    "NotificationsEmail": "antifragiletech@gmail.com",
    "GoogleSheetURL": "",
    "GoogleSheetIDKey": "",
    "GoogleSheetName": "",
    "PrivacyPolicyText": "",
    "PageDepth": "1",
    "CoverType": "1",
    "IsPublished": true,
    "LeadPhoneCountry": "",
    "LeadAfterPages": 0,
    "EmailsAllowed": "",
    "EmailVerifyTitleText": "antifragiletech@gmail.com",
    "EmailVerifyButtonText": "antifragiletech@gmail.com",
    "LeadSkipText": "",
    "OrdPos": 1,
    "IsStarred": false,
    "IsShowLogoMobile": true,
    "PreviewPDF": "",
    "IsForSale": false,
    "SaleCurr": "USD",
    "SaleAmount": 10,
    "SalePageTitle": "",
    "SaleAccessPageTitle": "",
    "SalePurchaseButtonText": "",
    "SaleButtonText": "",
    "SaleAccessButtonText": "",
    "SaleButtonColor": "#3366FF",
    "SaleGatewayName": "",
    "SaleGatewayKey": "",
    "SaleGatewaySecret": "",
    "EmailLeadSubject": "",
    "EmailLeadBody": " body",
    "EmailViewSubject": "antifragiletech@gmail.com",
    "EmailViewBody": "antifragiletech@gmail.com",
    "EmailSaleSubject": "antifragiletech@gmail.com",
    "EmailSaleBody": "antifragiletech@gmail.com",
    "TopLeft": "",
    "TopRight": "",
    "BottomLeft": "",
    "BottomRight": "",
    "IsCTAHiddenInPreview": false,
    "IsApprovalButton": false,
    "ApprovalButtonText": "Approve Document",
    "ApprovalButtonColor": "#000000",
    "ApprovalButtonTextColor": "#FFFFFF",
    "EmailApproveRequestSubject": "Document Approval Request: ##DOCUMENT_TITLE##",
    "EmailApproveRequestBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveRemindSubject": "Pending Document Approval: ##DOCUMENT_TITLE##",
    "EmailApproveRemindBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveSubmitSubject": "Document Approved: ##DOCUMENT_TITLE##",
    "EmailApproveSubmitBody": "<p>Hi,</p>\n<p>We are pleased to inform you that the following document has been approved:</p>\n<p>Name: <strong>##DOCU...",
    "IsBackgroundMusicLoop": false,
    "IsNavFirstLast": true,
    "IsShareFacebook": true,
    "IsShareTwitter": true,
    "IsShareWhatsApp": true,
    "IsShareTelegram": false,
    "IsShareLinkedIn": false,
    "IsSharePinterest": false,
    "IsShareReddit": false,
    "IsShareTumblr": false,
    "IsShareMessenger": false,
    "IsShareEmail": false,
    "IsShareLine": false,
    "IsShareWeChat": false,
    "IsShareInstagram": false,
    "IsShareFlipboard": false,
    "IsShareGeneral": false,
    "ScrollBehaviour": 1,
    "AIProvider": "",
    "AIKey": "",
    "IsVA": false,
    "VAButtonText": "",
    "VAButtonColor": "#3366FF",
    "VAButtonTextColor": "#3366FF",
    "VAText": "",
    "VAEmbeddings": "",
    "VAButtonStatus1": "0",
    "VAButtonStatus2": "0",
    "VAButtonStatus3": "0",
    "VAButtonStatus4": "0",
    "FrontPDF": "/docs/20001/f9496e75~dummy.pdf",
    "MiddlePDF": "/docs/20001/0b14ad4d~demo_multipage.pdf",
    "BackPDF": "/docs/20001/68504e6d~dummy.pdf",
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "WebhookURL_NewLead": "https://example.com/webhook-apitest",
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Weergeven

Geeft je flipbooks/documenten weer met paginering (PageNo/PageSize). Elk item bevat ID's, titel, URL's, aantal views/leads/verkopen, map en statusvlaggen.

GEThttps://go.fliplink.me/api/list
VereistenWie ben ik(een geldige API-sleutel)Weergeven

Queryparameters

Folder
SearchText
PageNonumberbijv. 1
PageSizenumberbijv. 25
Offsetnumberbijv. 0
SortByenumOptioneel. Een van: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Leeg = standaardvolgorde; onbekende waarden vallen terug op de standaard.Een van: Name, DocType, CreatedOn, NoOfViews, NoOfLeads
SortOrderenumOptioneel. `ASC` of `DESC`. Wordt genegeerd als SortBy leeg is. Onbekende waarden vallen stilzwijgend terug op de standaard.Een van: ASC, DESC

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list
curl -X GET 'https://go.fliplink.me/api/list?Folder=%3CFolder%3E&SearchText=%3CSearchText%3E&PageNo=1&PageSize=25&Offset=0&SortBy=%3CSortBy%3E&SortOrder=%3CSortOrder%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": 93286,
      "Name": "INSPECT matrix Document - Copy 000",
      "Title": "MX Title",
      "CreatedOn": "Jun 12 2026  4:48PM",
      "CreatedOnIso": "2026-06-12T22:18:49.723+05:30",
      "CreatedDate": "Jun 12, 2026",
      "CreatedTime": " 4:48PM",
      "ValidTillDate": "",
      "NoOfViews": 0,
      "CustomURL": "0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "Password": "",
      "FilePDF": "/docs/20001/0DF318DC~dummy.pdf",
      "NoOfLeads": 0,
      "NoOfSales": 0,
      "FullURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "EmbedURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "IMGPdf": "/Content/assets/media/users/no-image.png",
      "Pages": 0,
      "IsUnpublished": "",
      "Folder": "",
      "IsTemplate": false,
      "CNAMEMessage": "",
      "DocType": "Document",
      "DocTypeColor": "danger",
      "SSL": "No",
      "CompressDataKey": "",
      "Optimised": "",
      "IsPinnedThumbnails": true,
      "IsApprovalButton": true,
      "NoOfApprovals": 0,
      "FrontPDF": "/docs/20001/730d7569~dummy.pdf",
      "MiddlePDF": "/docs/20001/4b34cbea~dummy.pdf",
      "BackPDF": "/docs/20001/e4454ad1~dummy.pdf"
    }
  ],
  "TotalRecordCount": 14,
  "TotalItems": 14,
  "UserItems": 14,
  "PageSize": 10,
  "Capped": false
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

PDF-URL ophalen

Geeft de openbare S3-URL terug van de hoofd-PDF van het item (samengevoegde versie als die met een voor-/achterpagina is omhuld).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)PDF-URL ophalen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/get-pdf/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Items — wijzigen

Dupliceren

Maakt een of meer kopieën van een flipbook aan de serverkant — elke kopie krijgt zijn eigen nieuwe ID en share-URL. Je kunt er maximaal 20 tegelijk dupliceren (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Dupliceren

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

Countnumber1–500 (wordt serverside afgekapt)

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

POST/api/duplicate/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/duplicate/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Count=3'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

PDF vervangen (bestand)

Multipart-upload. Voegt automatisch opnieuw samen met de bestaande voor-/achterpagina als die is bijgevoegd.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)PDF vervangen (bestand)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Body (multipart/form-data)

Filefile

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/replace-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Body (form-data)

PDF vervangen (URL)

Vervangt de PDF van een bestaand flipbook door een PDF die de server downloadt van een URL die je opgeeft. Het flipbook houdt zijn ID, instellingen en sharelink.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)PDF vervangen (URL)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

FileURLbijv. https://example.com/new.pdf

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/replace-pdf-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'File=https://example.com/new.pdf'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Opslaan als sjabloon (aan/uit)

Markeert het flipbook als herbruikbaar sjabloon (Status=true) of haalt het uit de sjablonen (Status=false). Sjablonen verschijnen in list-templates en kunnen als basis dienen voor nieuwe flipbooks.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Opslaan als sjabloon (aan/uit)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

Statustrue | falsetrue/false. Standaard true als je dit weglaat.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/save-as-template/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/save-as-template/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Saved as template"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Aan map toewijzen

Verplaatst het flipbook naar een map om het te ordenen. Mappen worden op aanvraag aangemaakt — wijs het toe aan een mapnaam die nog niet bestaat en de map wordt automatisch aangemaakt (er is geen aparte 'map aanmaken'-aanroep). Stuur een lege Folder om het flipbook uit zijn map te halen. Een map bestaat alleen zolang er minstens één flipbook in zit, dus als je het laatste flipbook eruit haalt, verdwijnt de map uit list-folders. Mapnamen mogen een / bevatten (bijv. Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Aan map toewijzen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

FolderNaam van de map waar je het flipbook naartoe verplaatst — wordt aangemaakt als die niet bestaat (of hergebruik een naam uit list-folders). Stuur leeg om de toewijzing te wissen.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/assign-to-folder/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Voor-/achterpagina instellen (bestand)

Front en/of Back optioneel — minstens één is verplicht. Voegt opnieuw samen met de bestaande hoofd-PDF.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Voor-/achterpagina instellen (bestand)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Body (multipart/form-data)

Frontfile
Backfile

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Body (form-data)

Voor-/achterpagina instellen (URL)

URL-variant van set-front-back-page — voegt voor-/achterpagina's toe vanaf een externe PDF-URL in plaats van een geüpload bestand.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Voor-/achterpagina instellen (URL)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

FrontURLbijv. https://example.com/front.pdf
BackURLbijv. https://example.com/back.pdf

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-front-back-page-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Voor-/achterpagina wissen

Verwijdert de voor-/achterpagina-omhulling en herstelt FilePDF naar de niet-omhulde kern-PDF (MiddlePDF). Idempotent — een flipbook zonder omhulling geeft OK terug en verandert niets. Geeft { Result, Message, URL (S3-URL van de kern-PDF) } terug. Oude samengevoegde/voor-/achter-S3-objecten worden niet verwijderd.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Voor-/achterpagina wissen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/clear-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Vervaldatum instellen / verwijderen

Stelt de automatische vervaldatum van een flipbook in of verwijdert die. Stuur Days + Hours als gehele getallen; Days=-1, Hours=0 verwijdert de vervaldatum volledig.

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Vervaldatum instellen / verwijderen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

DaysnumberGebruik -1 om de vervaldatum te verwijderen
HoursnumberOptioneel, standaard 0

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-expiry/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-expiry/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Pinnen (aan/uit)

Pint of ontpint het flipbook (de gemarkeerde status) zodat het bovenaan je dashboard wordt gesorteerd.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Pinnen (aan/uit)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GerelateerdWeergeven
PUT/api/set-pin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Items — verwijderen

Verwijderen

Verwijdert het databaserecord van het flipbook definitief. Let op: de onderliggende S3-bestanden worden NIET automatisch verwijderd.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Verwijderen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

DELETE/api/delete/{flipbookId}
curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

CNAME (aangepaste domeinen)

CNAME toevoegen

Koppelt een al geactiveerd aangepast domein (CNAME) aan een flipbook. Het domein moet eerst via het webdashboard worden toegevoegd en geverifieerd (dat regelt DNS + SSL); dit endpoint legt alleen de koppeling vast — het verifieert geen DNS en geeft geen certificaten uit.

Voorwaarden:
- De CNAME moet al op je account bestaan (toegevoegd via het dashboard). Anders: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- Hij moet binnen de CNAME-limiet van je plan vallen.

Params:
- CNAME (verplicht) — volledige hostnaam, bijv. docs.example.com
- IsCloudflare (optioneel, standaard 0).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)CNAME toevoegen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

CNAMEbijv. docs.example.com
IsCloudflaretrue | falseOptioneel. 0 (standaard) of 1. Geef 1 door als je DNS achter de proxy van Cloudflare zit.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

POST/api/add-cname/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/add-cname/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CNAME=docs.example.com' \
  --data-urlencode 'IsCloudflare=0'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

CNAME's weergeven

Alle aangepaste CNAME's voor de aanroeper. Elk item: { CNAME, Documents (aantal actieve flipbooks), FlipbookIDs ([...] van de actieve flipbook-ID's die aan die CNAME gekoppeld zijn) }.

GEThttps://go.fliplink.me/api/list-cnames
VereistenWie ben ik(een geldige API-sleutel)CNAME's weergeven

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-cnames
curl -X GET 'https://go.fliplink.me/api/list-cnames' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

CNAME verwijderen

Verwijdert een koppeling met een aangepast domein (CNAME) van een of al je flipbooks. Twee modi:

  • Bulk (standaard): geef CNAME=<host> door en laat FlipbookID leeg — verwijdert die CNAME van elk flipbook dat je bezit.
  • Per flipbook: geef FlipbookID=<id> door — de CNAME wordt opgezocht aan de hand van dat flipbook. Gebruik dit voor een 'CNAME verwijderen'-actie per rij.

Respons (per flipbook): { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
Respons (bulk): { "Result": "OK", "Message": "CNAME removed successfully" }
Beide ontbreken: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

Opmerking: geef de CNAME door als queryparameter (niet als URL-segment) om problemen met de punten in de hostnaam te voorkomen.

DELETEhttps://go.fliplink.me/api/delete-cname
VereistenWie ben ik(een geldige API-sleutel)CNAME's weergeven(de CNAME / FlipbookID opzoeken)CNAME verwijderen

Queryparameters

CNAMEVerplicht voor de BULK-modus (verwijdert de CNAME van elk flipbook dat je bezit). Wordt genegeerd als FlipbookID > 0 — dan wordt de CNAME uit dat flipbook gehaald.
FlipbookIDnumberOptioneel. Geef een flipbook-ID > 0 door om de CNAME van ALLEEN dat ene flipbook te verwijderen (modus per flipbook). Laat leeg/weg/0 voor de bulkmodus (van alle verwijderen).

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

DELETE/api/delete-cname
curl -X DELETE 'https://go.fliplink.me/api/delete-cname?CNAME=docs.example.com&FlipbookID=%3CFlipbookID%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Mappen

Mappen weergeven

Geeft je mappen weer, elk als { Folder (naam), URL (een map-GUID) }. Mappen worden afgeleid van flipbooktoewijzingen (aangemaakt via assign-to-folder), dus een lege map wordt niet weergegeven. Mapnamen voeden assign-to-folder (om een flipbook te plaatsen) en set-team-member (om de toegang van een teamlid af te bakenen).

GEThttps://go.fliplink.me/api/list-folders
VereistenWie ben ik(een geldige API-sleutel)Mappen weergeven

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-folders
curl -X GET 'https://go.fliplink.me/api/list-folders' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Teamleden

Teamleden weergeven

Geeft de teamleden (vendor-gebruikers) op je account weer met hun toegangsgegevens, inclusief de mappen waaraan elk lid is toegewezen. Wachtwoorden worden nooit teruggegeven. Filter op IsActive.

GEThttps://go.fliplink.me/api/list-team-members
VereistenWie ben ik(een geldige API-sleutel)Teamleden weergeven

Queryparameters

IsActivetrue | false1=actief (standaard), 0=inactief

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-team-members
curl -X GET 'https://go.fliplink.me/api/list-team-members?IsActive=1' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Teamlid ophalen

Geeft één teamlid terug op basis van zijn member-ID (de ID uit list-team-members) — naam, e-mailadres, actieve status en de mappen waaraan het lid is toegewezen. Een teamlid is beperkt tot de mappen die via set-team-member zijn ingesteld (het veld Folders), dus het heeft alleen toegang tot flipbooks binnen die mappen. Wachtwoorden worden nooit teruggegeven. De memberId is de teamlid-ID (uit List Team Members) — geen flipbook-ID; een flipbook-ID doorgeven geeft "Team member not found". Het lid wordt teruggegeven verpakt in een Item-object; Folders is een door komma's gescheiden lijst van de mappen waar het toegang toe heeft (leeg = geen mapbeperking).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}
VereistenWie ben ik(een geldige API-sleutel)Teamlid instellen (aanmaken of bijwerken)(eerst een lid aanmaken)Teamlid ophalen

Padparameters

memberIdnumberTeamlid-ID (uit list-team-members). GEEN flipbook-ID.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200No team member with that ID (e.g. you passed a flipbook ID){ "Result": "ERROR", "Message": "Team member not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/get-team-member/{memberId}
curl -X GET 'https://go.fliplink.me/api/get-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Teamlid instellen (aanmaken of bijwerken)

Maakt een nieuw teamlid (vendor-gebruiker) aan of werkt een bestaand lid bij — je bepaalt wie toegang tot je account heeft en, via het veld Folders, tot welke mappen het lid beperkt is (een lid ziet alleen flipbooks binnen zijn toegewezen mappen). Bij succes wordt er een auditlog-vermelding geschreven.

Veelgemaakte fouten: de naam van het lid is één enkel Name-veld — er is geen FirstName/LastName. Folders is een door komma's gescheiden lijst van mapnamen uit List Folders (bijv. Marketing,Sales); laat het leeg voor geen mapbeperking. Een lid aanmaken geeft { Result:"OK", Message:"Team member created" } terug (het bijwerkpad — wanneer ID is opgegeven — geeft "Updated successfully"). Het e-mailadres van het lid mag nog niet bij een FlipLink-gebruiker horen, en e-mailadressen met een +-alias worden geweigerd.

POSThttps://go.fliplink.me/api/set-team-member
VereistenWie ben ik(een geldige API-sleutel)Mappen weergeven(namen voor de Folders-scope)Teamlid instellen (aanmaken of bijwerken)

Bodyparameters

Namebijv. Jane
Emailemailbijv. jane@example.com
IDnumberWeglaten of -1 om aan te maken. >0 om bij te werken.
PasswordPlatte tekst; serverside versleuteld. Leeg bij bijwerken houdt de bestaande waarde.
ProfileImageURL
FoldersMappen waartoe dit lid beperkt is — een gescheiden lijst van mapnamen (uit list-folders). Het lid heeft alleen toegang tot flipbooks binnen deze mappen.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

POST/api/set-team-member
curl -X POST 'https://go.fliplink.me/api/set-team-member' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Jane' \
  --data-urlencode 'Email=jane@example.com' \
  --data-urlencode 'ID=-1' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'ProfileImage=<ProfileImage>' \
  --data-urlencode 'Folders=<Folders>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Team member created"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Bodyparameters

Teamlid op actief zetten

Activeert of deactiveert een teamlid en bepaalt zo of het kan inloggen en toegang tot het account heeft.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}
VereistenWie ben ik(een geldige API-sleutel)Teamlid instellen (aanmaken of bijwerken)(eerst een lid aanmaken)Teamlid op actief zetten

Padparameters

memberIdnumberTeamlid-ID (uit list-team-members). GEEN flipbook-ID.

Bodyparameters

IsActivetrue | falsebijv. true

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-team-member-active/{memberId}
curl -X PUT 'https://go.fliplink.me/api/set-team-member-active/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsActive=true'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Teamlid verwijderen

Soft delete (deactivering). Teamleden worden nooit definitief verwijderd — dit deactiveert het lid (een REST-alias voor set-team-member-active met IsActive=false). Hun betalingsgeschiedenis en auditverwijzingen blijven intact, en ze kunnen later opnieuw worden geactiveerd via PUT /api/set-team-member-active (IsActive=true).

Respons: { "Result": "OK", "Message": "Team member deactivated" }.

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}
VereistenWie ben ik(een geldige API-sleutel)Teamlid instellen (aanmaken of bijwerken)(eerst een lid aanmaken)Teamlid verwijderen

Padparameters

memberIdnumberTeamlid-ID (uit list-team-members). GEEN flipbook-ID.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

DELETE/api/delete-team-member/{memberId}
curl -X DELETE 'https://go.fliplink.me/api/delete-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Team member deactivated"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Leads & verkopen

Leads weergeven

Geeft de lead-inzendingen weer die je flipbooks hebben verzameld. Geeft Items[] terug plus een dynamisch Columns[]-schema (om een tabel te renderen) en TotalRecordCount. Ondersteunt paginering en CSV-export via IsDownload.

GEThttps://go.fliplink.me/api/list-leads
VereistenWie ben ik(een geldige API-sleutel)Leads weergeven

Queryparameters

ItemIDsDoor komma OF pijp gescheiden flipbook-ID's (leeg = alle)
SearchText
PageNonumberbijv. 1
Offsetnumberbijv. 0
IsDownloadtrue | falsebijv. true

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-leads
curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Verkopen weergeven

Geeft verkoop-/aankoopgegevens van je flipbooks weer (e-mailadres koper, flipbook, bedrag, datum) plus de kolomdefinities voor de verkooptabel. Ondersteunt paginering en CSV-export via IsDownload.

GEThttps://go.fliplink.me/api/list-sales
VereistenWie ben ik(een geldige API-sleutel)Verkopen weergeven

Queryparameters

ItemIDs
SearchText
PageNonumberbijv. 1
Offsetnumberbijv. 0
IsDownloadtrue | falsebijv. true
IsAbandonedtrue | falsetrue → geeft verkopen van verlaten winkelwagens terug in plaats van afgeronde verkopen

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-sales
curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Lead verwijderen

Verwijdert één vastgelegde lead op basis van zijn ID. Het padsegment is de leadId; geef daarnaast het Email-adres van de lead en zijn FlipbookID door als queryparameters.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}
VereistenWie ben ik(een geldige API-sleutel)Leads weergeven(een lead-ID ophalen)Lead verwijderen

Padparameters

leadIdnumberDe ID van de lead (de LeadID uit list-leads).

Queryparameters

Emailemailbijv. foo@example.com
FlipbookIDnumberbijv. {{flipbookId}}

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

DELETE/api/delete-lead/{leadId}
curl -X DELETE 'https://go.fliplink.me/api/delete-lead/{leadId}?Email=foo%40example.com&FlipbookID=%7B%7BflipbookId%7D%7D' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Queryparameters

Leads verwijderen (bulk)

Verwijdert leads in bulk op basis van een filter. Minstens ÉÉN van FlipbookID/Email/DateFrom/DateTo is VERPLICHT — een aanroep zonder filter wordt geweigerd (er is geen 'alles verwijderen'-pad). Altijd vendor-scoped. Geeft { Result, Deleted (aantal) } terug. Ruimt ook onderliggende rijen op (viewlog / CTA-kliks / sheet-exportlog).

DELETEhttps://go.fliplink.me/api/delete-leads
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(afbakenen op FlipbookID)Leads verwijderen (bulk)

Queryparameters

FlipbookIDnumberOptioneel. Verwijder leads alleen op dit flipbook.
EmailemailOptioneel. Exact overeenkomend e-mailadres.
DateFromOptioneel. Verwijder leads die op/na deze datum zijn vastgelegd (komt overeen met Lead.CreatedOn). Elke leesbare datum, bijv. 2026-01-01 of 2026-01-01T00:00:00Z.
DateToOptioneel. Verwijder leads die op/vóór deze datum zijn vastgelegd.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

DELETE/api/delete-leads
curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID=%7B%7BflipbookId%7D%7D&Email=%3CEmail%3E&DateFrom=%3CDateFrom%3E&DateTo=%3CDateTo%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Flipbookaankoop registreren

Registreert een afgeronde flipbookverkoop (aankoop) — gebruik dit om aankopen vast te leggen die via je eigen betaalflow zijn gedaan, zonder FlipLinks Stripe-checkout te gebruiken.

Padparameter: {flipbookId} — het flipbook dat als gekocht wordt gemarkeerd.

Body (urlencoded):
- Email — e-mailadres van de koper (verplicht)
- PaymentRef — je referentie van de betaalgateway, bijv. een Stripe-PaymentIntent-ID (verplicht)

Respons (succes): { "Result": "OK", "Message": "Purchase recorded successfully" }
Respons (fout): { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

Veelgemaakte fouten: stuur PaymentRef; stuur GEEN Amount/Currency — die worden serverside afgeleid uit je betaalreferentie.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Flipbookaankoop registreren

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

EmailemailE-mailadres van de koper (verplicht).
PaymentRefPayment-intent-referentie van de gateway (verplicht). Voor Stripe is dit de PaymentIntent-ID (`pi_...`).

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

POST/api/set-flipbook-purchase/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Opzoekingen

Sjablonen weergeven

Geeft de herbruikbare flipbooksjablonen weer die op je account zijn opgeslagen. Filter op DocType (0 = alle). Gebruik de ID van een sjabloon met de save-as-template- / create-flows.

GEThttps://go.fliplink.me/api/list-templates
VereistenWie ben ik(een geldige API-sleutel)Sjablonen weergeven

Queryparameters

DocTypenumber0 = Flipbook (standaard), 1 = Document

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-templates
curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Skins weergeven

Geeft de beschikbare viewer-skins/-thema's weer; elke rij draagt de gebundelde achtergrond-URL van de skin. Gebruik de naam van een skin met set-skin.

GEThttps://go.fliplink.me/api/list-skins
VereistenWie ben ik(een geldige API-sleutel)Skins weergeven

Queryparameters

Typetrue | false0=Flipbook-skins, 1=Document-skins

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GerelateerdSkin instellen
GET/api/list-skins
curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Queryparameters

Valuta's weergeven

Geeft de valuta's weer die beschikbaar zijn bij het verkopen van een flipbook (voor de verkoop-/checkout-instellingen).

GEThttps://go.fliplink.me/api/list-currencies
VereistenWie ben ik(een geldige API-sleutel)Valuta's weergeven

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-currencies
curl -X GET 'https://go.fliplink.me/api/list-currencies' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Achtergrondmuziek weergeven

Geeft de ingebouwde achtergrondmuzieknummers weer die je aan een flipbook-viewer kunt koppelen.

GEThttps://go.fliplink.me/api/list-background-music
VereistenWie ben ik(een geldige API-sleutel)Achtergrondmuziek weergeven

Geen parameters.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GET/api/list-background-music
curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Secties — branding & content

Meta instellen

Stelt de titel en SEO-meta van het flipbook in — Title, Description, TitleColor en de IsPublished-vlag.

Opmerking: dit overschrijft Title/Description/TitleColor. Gebruik set-published om alleen de publicatiestatus te wijzigen.

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Meta instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

Title
Description
TitleColor
IsPublishedtrue | falsebijv. false

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-meta/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-meta/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=<Title>' \
  --data-urlencode 'Description=<Description>' \
  --data-urlencode 'TitleColor=<TitleColor>' \
  --data-urlencode 'IsPublished=false'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Publicatie instellen (publiceren / depubliceren)

Publiceert of depubliceert het flipbook — verandert ALLEEN de publicatievlag en laat Title/Description/TitleColor intact (anders dan set-meta). Gebruik het om een flipbook (opnieuw) te publiceren, bijv. een dat na create-by-file als gedepubliceerd terugkwam.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Publicatie instellen (publiceren / depubliceren)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsPublishedtrue | falsetrue/1 = publiceren, false/0 = depubliceren (verplicht).

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GerelateerdMeta instellen
PUT/api/set-published/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-published/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Skin instellen

Past een viewer-skin/-thema toe op het flipbook; de server zet de skinnaam om naar de bijbehorende ID.

Veelgemaakte fouten: het veld is SkinName (de tekenreeks uit list-skins), geen numerieke ID.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Skins weergeven(een SkinName kiezen)Skin instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

SkinNameUit /api/list-skins → kolom Name

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GerelateerdSkins weergeven
PUT/api/set-skin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-skin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName=<SkinName>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Achtergrondafbeelding instellen

Stelt de achtergrondafbeelding van de viewer in vanaf een URL die je opgeeft (er is geen ingebouwde galerij).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Achtergrondafbeelding instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

BackgroundIMGURLAfbeeldings-URL OF placeholder-URL zoals https://plchldr.co/i/100x100?text=&bg=HEX

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-background-image/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-image/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG=<BackgroundIMG>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Favicon instellen

Stelt de favicon (het tabbladpictogram) in die de gehoste viewerpagina van het flipbook gebruikt.

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Favicon instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

FaviconIMGURL

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

GerelateerdLogo instellen
PUT/api/set-favicon/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-favicon/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG=<FaviconIMG>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Pagina-uiterlijk instellen

Configureert het pagina-uiterlijk van de viewer — achtergrond, paginaschaduw, ruimte en gerelateerde look-and-feel-opties. Waarden worden letterlijk opgeslagen; oudere items kunnen andere waarden teruggeven (bijv. regular of het numerieke 1) als je ze via Get one uitleest.

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Pagina-uiterlijk instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

PageDepthenumflat | thin | thickEen van: flat, thin, thick
CoverTypeenumsoft | hardEen van: soft, hard

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-page-appearance/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Laadtekst instellen

Stelt de aangepaste tekst in die op het laadscherm van de viewer wordt getoond.

Veelgemaakte fouten: het veld is CustomLoadingText, niet LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Laadtekst instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

CustomLoadingText

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-loading-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-loading-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText=<CustomLoadingText>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Aangepaste URL instellen

Stelt de aangepaste (vanity-)slug voor de share-URL van het flipbook in. Moet uniek zijn; een slug die al in gebruik is geeft Result:ERROR.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Aangepaste URL instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

CustomURL

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Custom URL already taken{ "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-custom-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-custom-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=<CustomURL>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Voorbeeld-PDF instellen

Stelt de voorbeeld-PDF in die lezers te zien krijgen vóór de leadcapture / betaling. Wordt automatisch gewist als zowel leadcapture als verkoopmodus uit staan.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Voorbeeld-PDF instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

PreviewPDFURL

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-preview-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=<PreviewPDF>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Afbeeldings-PDF instellen

Stelt de afbeeldings-/voorbeeld-PDF in die voor thumbnails en voorbeelden wordt gebruikt. Stuur leeg om de bestaande afbeeldings-PDF te behouden.

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Afbeeldings-PDF instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IMGPdfURL

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-image-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=<IMGPdf>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — viewer & lezer

Viewerknoppen instellen

Toont of verbergt afzonderlijke knoppen op de werkbalk van de viewer (downloaden, printen, delen, volledig scherm, zoomen, thumbnails, enzovoort).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Viewerknoppen instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsShowControlstrue | falsebijv. true
IsPrinttrue | falsebijv. false
IsDownloadtrue | falsebijv. false
IsThumbnailstrue | falsebijv. true
IsSearchtrue | falsebijv. true
IsSoundtrue | falsebijv. true
IsFullscreentrue | falsebijv. true
IsZoomtrue | falsebijv. true
IsNotestrue | falsebijv. false

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-viewer-controls/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Lezersnavigatie instellen

Configureert de lezersnavigatie in de viewer — paginathumbnails, inhoudsopgave en hoe lezers tussen pagina's wisselen.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Lezersnavigatie instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsNavFirstLasttrue | falsebijv. true
BookLayoutenum1=enkel, 2=dubbelEen van: 1, 2
IsRightToLefttrue | falsebijv. false
ScrollBehaviournumberNumerieke scrollmodus

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-reader-navigation/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Automatisch bladeren instellen

Schakelt automatisch bladeren in de viewer in of uit, samen met het bijbehorende interval.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Automatisch bladeren instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

AutoFlipInSecsnumberMILLISECONDEN, ondanks de naam. 0 = uit, 3000 = 3s, 5000 = 5s, enzovoort.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-auto-flip/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Achtergrondmuziek instellen

Stelt het achtergrondmuzieknummer in dat in de viewer speelt, of wist het. Zie list-background-music voor de beschikbare nummers.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Achtergrondmuziek weergeven(een nummer kiezen)Achtergrondmuziek instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

BackgroundMusicVooraf ingestelde bestandsnaam van het nummer (uit /api/list-background-music)
BackgroundMusicCustomURLURL van zelf geüploade muziek
IsBackgroundMusicLooptrue | falsebijv. false

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-background-music/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-music/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=<BackgroundMusic>' \
  --data-urlencode 'BackgroundMusicCustom=<BackgroundMusicCustom>' \
  --data-urlencode 'IsBackgroundMusicLoop=false'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — CTA's

Primaire CTA instellen

Configureert de primaire call-to-action-knop in de viewer (label, URL, positie, kleur).

Veelgemaakte fouten: de velden zijn IsCTAButton, CTAButtonText, CTAButtonURL (plus positie/kleur) — niet Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Primaire CTA instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsCTAButtontrue | falsebijv. false
CTAButtonText
CTAButtonColor
CTAButtonURLURLmailto:- / tel:-voorvoegsels worden serverside automatisch genormaliseerd
CTAButtonTextColor

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-cta-primary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=<CTAButtonText>' \
  --data-urlencode 'CTAButtonColor=<CTAButtonColor>' \
  --data-urlencode 'CTAButtonURL=<CTAButtonURL>' \
  --data-urlencode 'CTAButtonTextColor=<CTAButtonTextColor>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secundaire CTA instellen

Configureert de secundaire call-to-action-knop in de viewer.

Veelgemaakte fouten: de secundaire knop gebruikt de velden met het achtervoegsel 2IsCTAButton2, CTAButtonText2, CTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Secundaire CTA instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsCTAButton2true | falsebijv. false
CTAButtonText2
CTAButtonColor2
CTAButtonTextColor2
CTAButtonURL2URL

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-cta-secondary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=<CTAButtonText2>' \
  --data-urlencode 'CTAButtonColor2=<CTAButtonColor2>' \
  --data-urlencode 'CTAButtonTextColor2=<CTAButtonTextColor2>' \
  --data-urlencode 'CTAButtonURL2=<CTAButtonURL2>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

CTA-voorbeeldregels instellen

Configureert wanneer de call-to-action aan lezers wordt getoond — bijv. na N pagina's of N seconden (de regels voor de voorbeeldpoort).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)CTA-voorbeeldregels instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsCTAHiddenInPreviewtrue | falsebijv. false

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-cta-preview-rules/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — toegangsbeheer

Wachtwoordtoegang instellen

Zet de wachtwoordbeveiliging voor het flipbook aan/uit en stelt het toegangswachtwoord in.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Wachtwoordtoegang instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsPasswordProtectedtrue | falsebijv. false
Password
PwdTitle
PwdPlaceholder
PwdButton

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-password-access/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-password-access/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'PwdTitle=<PwdTitle>' \
  --data-urlencode 'PwdPlaceholder=<PwdPlaceholder>' \
  --data-urlencode 'PwdButton=<PwdButton>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Indexering instellen

Bepaalt de indexering van het gehoste flipbook door zoekmachines. IsNoIndex=true voegt een robots-noindex toe zodat de pagina niet wordt geïndexeerd.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Indexering instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsNoIndextrue | falsebijv. false

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-indexing/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-indexing/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNoIndex=false'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

E-maillijst voor toegang instellen

Beperkt de toegang tot de viewer tot een lijst met toegestane e-mailadressen (afgeschermd lezen).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)E-maillijst voor toegang instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

EmailsAllowedGescheiden lijst van toegestane e-mailadressen

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-email-allow-list/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=<EmailsAllowed>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — leadcapture

Leadcapture instellen (basis)

Schakelt het basis-leadcaptureformulier in en configureert het (de poort die gegevens van lezers verzamelt voordat ze lezen).

Veelgemaakte fouten: de inschakelvlag is IsLeadCapture, niet IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsLeadCapturetrue | falsebijv. false
LeadCaptureTitle
IsLeadAllowSkiptrue | falsebijv. false
LeadSkipText
LeadFormAfterPagesnumberbijv. 0
LeadAfterPagesnumberbijv. 0

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-capture/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=false' \
  --data-urlencode 'LeadCaptureTitle=<LeadCaptureTitle>' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=<LeadSkipText>' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Leadvelden instellen

Schakelt elk standaard leadcaptureveld in/uit (naam, e-mailadres, telefoon, bedrijf, enzovoort) en bepaalt of het verplicht is.

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)(leadcapture inschakelen)Leadvelden instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsLeadEmailtrue | falsebijv. true
IsLeadEmailMandatorytrue | falsebijv. true
IsLeadNametrue | falsebijv. true
IsLeadNameMandatorytrue | falsebijv. false
IsLeadPhonetrue | falsebijv. false
IsLeadPhoneMandatorytrue | falsebijv. false
IsLeadCompanytrue | falsebijv. false
IsLeadCompanyMandatorytrue | falsebijv. false
IsLeadDatetrue | falsebijv. false
IsLeadDateMandatorytrue | falsebijv. false
LeadPhoneCountry

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry=<LeadPhoneCountry>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Aangepaste leadvelden instellen

Definieert extra aangepaste velden op het leadcaptureformulier, naast de standaard naam/e-mail/telefoon.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)(leadcapture inschakelen)Aangepaste leadvelden instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsLeadCustom1true | falsebijv. false
IsLeadCustom1Mandatorytrue | falsebijv. false
Custom1Label
IsLeadCustom2true | falsebijv. false
IsLeadCustom2Mandatorytrue | falsebijv. false
Custom2Label

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-custom-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=<Custom1Label>' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label=<Custom2Label>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Leadlabels instellen

Stelt de weergavelabels en placeholdertekst in voor de velden van het leadcaptureformulier.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)(leadcapture inschakelen)Leadlabels instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

LeadEmailemail
LeadName
LeadPhonephone
LeadCompany
LeadDate
LeadButton

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-labels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=<LeadEmail>' \
  --data-urlencode 'LeadName=<LeadName>' \
  --data-urlencode 'LeadPhone=<LeadPhone>' \
  --data-urlencode 'LeadCompany=<LeadCompany>' \
  --data-urlencode 'LeadDate=<LeadDate>' \
  --data-urlencode 'LeadButton=<LeadButton>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Leadprivacy instellen

Configureert de privacy-/toestemmingstekst en -opties van de leadcapture (bijv. het AVG-toestemmingsvinkje).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)(leadcapture inschakelen)Leadprivacy instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsLeadPrivacyPolicytrue | falsebijv. false
PrivacyPolicyURLURL
PrivacyPolicyText

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-privacy/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=<PrivacyPolicyURL>' \
  --data-urlencode 'PrivacyPolicyText=<PrivacyPolicyText>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Leadverificatie instellen

Zet de e-mailverificatie van leads aan of uit, waarbij lezers hun e-mailadres moeten bevestigen voordat ze toegang krijgen.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)(leadcapture inschakelen)Leadverificatie instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsVerifyEmailtrue | falsebijv. false
IsVerifyMobiletrue | falsebijv. false
TwillioAPIKeyJe Twilio-API-sleutel (de veldnaam houdt de oorspronkelijke spelling 'Twillio' aan).
EmailVerifyTitleText
EmailVerifyButtonText

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-verification/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=<TwillioAPIKey>' \
  --data-urlencode 'EmailVerifyTitleText=<EmailVerifyTitleText>' \
  --data-urlencode 'EmailVerifyButtonText=<EmailVerifyButtonText>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Lead-webhook instellen

Stelt een webhook-URL in die elke nieuwe lead ontvangt (opgeslagen als de new-lead-webhook). Gebruik test-webhook om te controleren of die afgaat.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)(leadcapture inschakelen)Lead-webhook instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

WebhookURL_NewLeadURLJe endpoint-URL — ontvangt een JSON-payload voor elke nieuwe lead.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-webhook/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=<WebhookURL_NewLead>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Webhook testen

Stuurt een TEST-payload naar de geconfigureerde lead-webhook van het flipbook zodat je het bezorgformaat kunt controleren zonder een echte lead. Geeft ERROR 'No lead webhook is configured for this flipbook.' terug als er geen is ingesteld. De vorm van de payload komt overeen met een echte lead (keys: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2), maar bevat dummywaarden (pdf_id:"-1", pdf_name:"Test PDF", ...). Er wordt geen echte lead opgeslagen en er wordt geen meldingse-mail verstuurd.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Lead-webhook instellen(er moet eerst een webhook geconfigureerd zijn)Webhook testen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

POST/api/test-webhook/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Lead-Google Sheets instellen

Koppelt de leadcapture aan een Google Sheet — nieuwe leads worden toegevoegd aan de sheet die je opgeeft (sheet-ID + naam).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Leadcapture instellen (basis)(leadcapture inschakelen)Lead-Google Sheets instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

GoogleSheetURLURL
GoogleSheetIDKey
GoogleSheetName

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-lead-google-sheets/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=<GoogleSheetURL>' \
  --data-urlencode 'GoogleSheetIDKey=<GoogleSheetIDKey>' \
  --data-urlencode 'GoogleSheetName=<GoogleSheetName>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — meldingen & e-mailsjablonen

Meldingen instellen

Configureert welke e-mailmeldingen je voor dit flipbook ontvangt (nieuwe lead, nieuwe view, nieuwe verkoop).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Meldingen instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

NotificationsEmailemail
IsSendEmailOnViewtrue | falsebijv. false

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-notifications/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-notifications/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=<NotificationsEmail>' \
  --data-urlencode 'IsSendEmailOnView=false'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

E-mailsjabloon instellen — nieuwe lead

Stelt de e-mail in die bij een new-lead-event wordt verstuurd. Stuur lege waarden om het standaard NEW_LEAD-sjabloon te herstellen.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)E-mailsjabloon instellen — nieuwe lead

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

EmailLeadSubject
EmailLeadBody

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-email-template-lead/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=<EmailLeadSubject>' \
  --data-urlencode 'EmailLeadBody=<EmailLeadBody>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

E-mailsjabloon instellen — nieuwe view

Stelt het e-mailsjabloon in dat bij een new-view-melding wordt verstuurd. Stuur leeg om het standaard NEW_VIEW-sjabloon te herstellen.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)E-mailsjabloon instellen — nieuwe view

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

EmailViewSubject
EmailViewBody

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-email-template-view/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=<EmailViewSubject>' \
  --data-urlencode 'EmailViewBody=<EmailViewBody>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

E-mailsjabloon instellen — nieuwe verkoop

Stelt het e-mailsjabloon in dat bij een new-sale-melding wordt verstuurd. Stuur leeg om het standaard NEW_SALE-sjabloon te herstellen.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)E-mailsjabloon instellen — nieuwe verkoop

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

EmailSaleSubject
EmailSaleBody

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-email-template-sale/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=<EmailSaleSubject>' \
  --data-urlencode 'EmailSaleBody=<EmailSaleBody>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — verkopen

Verkoopinstellingen instellen

Configureert het verkopen van het flipbook (prijs, valuta, opties). Als je de verkoopmodus inschakelt, wordt e-mailverificatie automatisch ingeschakeld en wordt het lead-e-mailadres verplicht.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Valuta's weergeven(SaleCurr kiezen)Verkoopinstellingen instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsForSaletrue | falsebijv. false
SaleCurrUit /api/list-currencies
SaleAmountnumberbijv. 0

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-sale-settings/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=false' \
  --data-urlencode 'SaleCurr=USD' \
  --data-urlencode 'SaleAmount=0'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Verkooppaginatekst instellen

Stelt de marketingtekst in die op de verkoop-/checkout-pagina van het flipbook wordt getoond.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Verkoopinstellingen instellen(verkopen inschakelen)Verkooppaginatekst instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

SalePageTitle
SaleAccessPageTitle
SalePurchaseButtonText
SaleButtonText
SaleAccessButtonText
SaleButtonColor

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-sale-page-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=<SalePageTitle>' \
  --data-urlencode 'SaleAccessPageTitle=<SaleAccessPageTitle>' \
  --data-urlencode 'SalePurchaseButtonText=<SalePurchaseButtonText>' \
  --data-urlencode 'SaleButtonText=<SaleButtonText>' \
  --data-urlencode 'SaleAccessButtonText=<SaleAccessButtonText>' \
  --data-urlencode 'SaleButtonColor=<SaleButtonColor>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Verkoopgateway instellen

Selecteert en configureert de betaalgateway die wordt gebruikt bij de verkoop van dit flipbook.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Verkoopinstellingen instellen(verkopen inschakelen)Verkoopgateway instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

SaleGatewayName
SaleGatewayKey
SaleGatewaySecret

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-sale-gateway/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=<SaleGatewayName>' \
  --data-urlencode 'SaleGatewayKey=<SaleGatewayKey>' \
  --data-urlencode 'SaleGatewaySecret=<SaleGatewaySecret>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — goedkeuring

Goedkeuringsknop instellen

Voegt een knop voor een goedkeuringsverzoek toe aan de viewer. Door die in te schakelen start je de goedkeuringsworkflow.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(DocType=document — alleen Document-items)Goedkeuringsknop instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsApprovalButtontrue | falsebijv. false
ApprovalButtonText
ApprovalButtonColor
ApprovalButtonTextColor

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-approval-button/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-button/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=false' \
  --data-urlencode 'ApprovalButtonText=<ApprovalButtonText>' \
  --data-urlencode 'ApprovalButtonColor=<ApprovalButtonColor>' \
  --data-urlencode 'ApprovalButtonTextColor=<ApprovalButtonTextColor>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Goedkeurings-e-mailsjablonen instellen

Stelt de e-mailsjablonen in die de goedkeuringsworkflow gebruikt. Lege waarden halen de standaardsjablonen op.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(DocType=document — alleen Document-items)Goedkeurings-e-mailsjablonen instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

EmailApproveRequestSubject
EmailApproveRequestBody
EmailApproveRemindSubject
EmailApproveRemindBody
EmailApproveSubmitSubject
EmailApproveSubmitBody

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-approval-email-templates/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=<EmailApproveRequestSubject>' \
  --data-urlencode 'EmailApproveRequestBody=<EmailApproveRequestBody>' \
  --data-urlencode 'EmailApproveRemindSubject=<EmailApproveRemindSubject>' \
  --data-urlencode 'EmailApproveRemindBody=<EmailApproveRemindBody>' \
  --data-urlencode 'EmailApproveSubmitSubject=<EmailApproveSubmitSubject>' \
  --data-urlencode 'EmailApproveSubmitBody=<EmailApproveSubmitBody>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — delen

Hoofdschakelaar delen instellen

Hoofdschakelaar (aan/uit) voor de deelknoppen in de viewer.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Hoofdschakelaar delen instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsShareButtonstrue | falsebijv. false

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-share-master/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-master/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareButtons=false'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Deelkanalen instellen

Schakelt elk sociaal deelkanaal (Facebook, X, LinkedIn, WhatsApp, e-mail, enzovoort) afzonderlijk in/uit in het deelmenu van de viewer.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Deelkanalen instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsShareFacebooktrue | falsebijv. true
IsShareTwittertrue | falsebijv. true
IsShareWhatsApptrue | falsebijv. true
IsShareTelegramtrue | falsebijv. false
IsShareLinkedIntrue | falsebijv. true
IsSharePinteresttrue | falsebijv. false
IsShareReddittrue | falsebijv. false
IsShareTumblrtrue | falsebijv. false
IsShareMessengertrue | falsebijv. false
IsShareEmailtrue | falsebijv. true
IsShareLinetrue | falsebijv. false
IsShareWeChattrue | falsebijv. false
IsShareInstagramtrue | falsebijv. false
IsShareFlipboardtrue | falsebijv. false
IsShareGeneraltrue | falsebijv. true

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-share-channels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-channels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareFacebook=true' \
  --data-urlencode 'IsShareTwitter=true' \
  --data-urlencode 'IsShareWhatsApp=true' \
  --data-urlencode 'IsShareTelegram=false' \
  --data-urlencode 'IsShareLinkedIn=true' \
  --data-urlencode 'IsSharePinterest=false' \
  --data-urlencode 'IsShareReddit=false' \
  --data-urlencode 'IsShareTumblr=false' \
  --data-urlencode 'IsShareMessenger=false' \
  --data-urlencode 'IsShareEmail=true' \
  --data-urlencode 'IsShareLine=false' \
  --data-urlencode 'IsShareWeChat=false' \
  --data-urlencode 'IsShareInstagram=false' \
  --data-urlencode 'IsShareFlipboard=false' \
  --data-urlencode 'IsShareGeneral=true'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Secties — tracking & AI

Analytics-tracking instellen

Voegt je eigen analytics-tracking-ID's (bijv. Google Analytics, GTM, Facebook Pixel) toe aan het gehoste flipbook.

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Analytics-tracking instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

FacebookAnalyticsCode
GoogleAnalyticsCode
GoogleTagManager

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-analytics-tracking/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=<FacebookAnalyticsCode>' \
  --data-urlencode 'GoogleAnalyticsCode=<GoogleAnalyticsCode>' \
  --data-urlencode 'GoogleTagManager=<GoogleTagManager>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

AI-provider instellen

Configureert de AI-provider die voor AI-functies wordt gebruikt — de naam van de provider en de bijbehorende API-sleutel.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)AI-provider instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

AIProvider
AIKey

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-ai-provider/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=<AIProvider>' \
  --data-urlencode 'AIKey=<AIKey>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Virtuele assistent instellen

Configureert de basisinstellingen van de virtuele assistent (chat/hulp) in de viewer.

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Virtuele assistent instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

IsVAtrue | falsebijv. false
VAButtonText
VAButtonColor
VAButtonTextColor
VATextPrompt / instructies voor de assistent
VAEmbeddingsEmbeddings-blob (string)

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-virtual-assistant/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=<VAButtonText>' \
  --data-urlencode 'VAButtonColor=<VAButtonColor>' \
  --data-urlencode 'VAButtonTextColor=<VAButtonTextColor>' \
  --data-urlencode 'VAText=<VAText>' \
  --data-urlencode 'VAEmbeddings=<VAEmbeddings>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters

Statustekst virtuele assistent instellen

Stelt de status-/begroetingstekst in die de virtuele assistent in de viewer toont.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}
VereistenWie ben ik(een geldige API-sleutel)Aanmaken via bestand(een flipbookId ophalen)Statustekst virtuele assistent instellen

Padparameters

flipbookIdnumberNumeriek ID van het flipbook/document — teruggegeven door create-by-file / create-by-url (als ID) of list.

Bodyparameters

VAButtonStatus1Label voor de status 'luisteren'
VAButtonStatus2Label voor de status 'opnemen'
VAButtonStatus3Label voor de status 'verwerken'
VAButtonStatus4Label voor de status 'spreken'

Foutresponsen

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Een ontbrekende/ongeldige sleutel wordt geweigerd met HTTP 401 (een HTML-pagina, geen JSON). Elke andere fout geeft HTTP 200 terug met { "Result": "ERROR", "Message": … } — vertak dus altijd op Result, niet alleen op de HTTP-status.

PUT/api/set-virtual-assistant-status-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=<VAButtonStatus1>' \
  --data-urlencode 'VAButtonStatus2=<VAButtonStatus2>' \
  --data-urlencode 'VAButtonStatus3=<VAButtonStatus3>' \
  --data-urlencode 'VAButtonStatus4=<VAButtonStatus4>'
Voorbeeldrespons200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Plak je API-sleutel in “Je API-sleutel” bovenaan — vul daarna de velden hieronder in en verstuur.

Padparameters — vereist om het item te identificeren

Bodyparameters