FlipLink API-Referenz

Profil

Wer bin ich

Gibt das Konto zurück, dem der API-Schlüssel gehört — User-/Vendor-IDs, Name, E-Mail, Marke, App-URL und die maximale Upload-Größe des Tarifs (MaxFileSizeMB).

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

Voraussetzungen — keine. Dies ist der Wurzelaufruf: Er authentifiziert deinen API-Schlüssel, die Voraussetzung für jeden anderen Endpunkt.

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtAbodetails abrufen Profil abrufen

GET/api/whoami

curl -X GET 'https://go.fliplink.me/api/whoami' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Profil abrufen

Gibt das Kontoprofil zum API-Schlüssel zurück — Anzeigename, Telefonnummer und die URL des Profilbilds.

GEThttps://go.fliplink.me/api/get-profile

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Profil abrufen

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtProfil festlegen (teilweise)Wer bin ich

GET/api/get-profile

curl -X GET 'https://go.fliplink.me/api/get-profile' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Profil festlegen (teilweise)

Teilweise Aktualisierung — ausgelassene Felder behalten ihre vorhandenen Werte. Mindestens ein Feld ist erforderlich.

PUThttps://go.fliplink.me/api/set-profile

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Profil festlegen (teilweise)

Body-Parameter

`Name`	z. B. `Mark Stevens`
`Phone`phone	z. B. `+14155550142`
`ProfileImage`URL	z. B. `https://...`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtProfil abrufen

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://...'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Body-Parameter

Name

Phonephone

ProfileImageURL

Abonnement & Zahlungen

Abodetails abrufen

Gibt deinen aktuellen Tarif und dein Kontingent zurück — Tarifname, Status, Gebühren, Datum der nächsten Rechnung, maximale Dateigröße, maximale Anzahl an Items/CNAMEs sowie Feature-Flags.

GEThttps://go.fliplink.me/api/get-subscription-details

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Abodetails abrufen

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtZahlungen auflisten Wer bin ich

GET/api/get-subscription-details

curl -X GET 'https://go.fliplink.me/api/get-subscription-details' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 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"
  }
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Zahlungen auflisten

Gibt deinen Zahlungsverlauf zurück — jeden Tarifkauf bzw. jede Verlängerung mit Bestell-ID, Betrag, Tarif, Datum und Anzahl der Items.

GEThttps://go.fliplink.me/api/list-payments

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Zahlungen auflisten

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtAbodetails abrufen

GET/api/list-payments

curl -X GET 'https://go.fliplink.me/api/list-payments' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 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
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Items — Erstellen

Per Datei erstellen

Erstellt ein Flipbook (oder Dokument) aus einer hochgeladenen PDF, gesendet als multipart/form-data. Die Datei wird gespeichert, ein Thumbnail wird erzeugt und der Datensatz wird angelegt.

Hinweise
- Ob du ein Flipbook oder ein Dokument erhältst, bestimmt der Host-Header der Anfrage — go.fliplink.me (Standard) gibt Flipbooks zurück, go.doclink.me gibt Dokumente zurück.
- *_Count / *_Max / *_Left spiegeln dein Tarifkontingent nach diesem Erstellvorgang wider.
- Verwende die zurückgegebene ID für Folgeaufrufe (set-meta, set-cta-primary, save-as-template usw.).
- Die maximale Dateigröße hängt vom Tarif ab (siehe MaxFileSizeMB aus who-am-i).

POSThttps://go.fliplink.me/api/create-by-file

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen

Body (multipart/form-data)

`File`file	—
`Name`	z. B. `My Document`
`Title`	z. B. `My Title`
`DocType`enum	Flipbook oder Dokument. Auf go.doclink.me immer als Dokument behandelt.Eines von: `Flipbook`, `Document`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPer URL erstellen Einzelnes abrufen Meta festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Body (form-data)

Filefile

Name

Title

DocTypechoose oneFlipbook oder Dokument. Auf go.doclink.me immer als Dokument behandelt.

Per URL erstellen

Erstellt ein Flipbook (oder Dokument) aus einer PDF-URL. Der Server lädt FileURL herunter, lädt die Datei zu S3 hoch, erzeugt ein Thumbnail und legt den Datensatz an.

Hinweise
- Ob das Feldnamen-Präfix Flipbooks_* oder Documents_* verwendet wird, bestimmt der Host-Header der Anfrage — go.fliplink.me (Standard) gibt Flipbooks zurück, go.doclink.me gibt Dokumente zurück.
- *_Count / *_Max / *_Left spiegeln das Tarifkontingent des Kontos nach diesem Erstellvorgang wider.
- Die Quell-URL muss innerhalb von 60 s antworten — langsame oder nicht erreichbare Quellen schlagen fehl mit Source URL timed out after 60s. Bei unzuverlässigen Quellen verwende lieber /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per URL erstellen

Body-Parameter

`FileURL`URL	z. B. `https://example.com/document.pdf`
`Name`	z. B. `My Document`
`Title`	z. B. `My Title`
`DocType`enum	z. B. `Flipbook`Eines von: `Flipbook`, `Document`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPer Datei erstellen Einzelnes abrufen Meta festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Body-Parameter

FileURLURL

Name

Title

DocTypechoose one

Items — Lesen

Einzelnes abrufen

Gibt den vollständigen Datensatz für ein einzelnes Flipbook/Dokument anhand der ID zurück — jede gespeicherte Spalte: Titel, URLs, View-/Lead-/Sale-Zähler, Ordner und Status-Flags. Der vollständige Datensatz wird in ein `Item`-Objekt eingebettet mit ca. 190 Spalten zurückgegeben; das Beispiel unten ist eine gekürzte, repräsentative Teilmenge.

GEThttps://go.fliplink.me/api/get/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Einzelnes abrufen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPer URL finden PDF-URL abrufen Freigabe-Link abrufen Auflisten

GET/api/get/{flipbookId}

curl -X GET 'https://go.fliplink.me/api/get/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 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"
  }
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Per URL finden

Sucht ein Flipbook anhand seiner öffentlichen/Freigabe-URL und gibt seinen vollständigen Datensatz zurück (gleiche Struktur wie get).

GEThttps://go.fliplink.me/api/find-by-url

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per URL finden

Query-Parameter

URLURL Vollständige Viewer-URL, eine CNAME-URL oder nur der reine CustomURL-Slug. Der Server nimmt das letzte Pfadsegment als Slug.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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'

Beispielantwort200 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"
  }
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

URLURLVollständige Viewer-URL, eine CNAME-URL oder nur der reine CustomURL-Slug. Der Server nimmt das letzte Pfadsegment als Slug.

Auflisten

Listet deine Flipbooks/Dokumente mit Paginierung auf (PageNo/PageSize). Jedes Item enthält IDs, Titel, URLs, View-/Lead-/Sale-Zähler, Ordner und Status-Flags.

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

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Auflisten

Query-Parameter

`Folder`	—
`SearchText`	—
`PageNo`number	z. B. `1`
`PageSize`number	z. B. `25`
`Offset`number	z. B. `0`
`SortBy`enum	Optional. Eines von: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Leer = Standardsortierung; unbekannte Werte fallen auf den Standard zurück.Eines von: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`
`SortOrder`enum	Optional. `ASC` oder `DESC`. Wird ignoriert, wenn SortBy leer ist. Unbekannte Werte fallen stillschweigend auf den Standard zurück.Eines von: `ASC`, `DESC`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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'

Beispielantwort200 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
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

Folder

SearchText

PageNonumber

PageSizenumber

Offsetnumber

SortBychoose oneOptional. Eines von: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Leer = Standardsortierung; unbekannte Werte fallen auf den Standard zurück.

SortOrderchoose oneOptional. `ASC` oder `DESC`. Wird ignoriert, wenn SortBy leer ist. Unbekannte Werte fallen stillschweigend auf den Standard zurück.

PDF-URL abrufen

Gibt die öffentliche S3-URL der Haupt-PDF des Items zurück (zusammengeführte Version, falls vorne/hinten umschlossen).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→PDF-URL abrufen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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'

Beispielantwort200 OK

{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Freigabe-Link abrufen

Gibt die öffentliche Viewer-URL des Flipbooks zurück (sein Custom-Domain-/Host-Präfix plus den Freigabe-Slug des Flipbooks).

Antwort: { "Result": "OK", "URL": "https://go.fliplink.me/view/<guid>" }.

GEThttps://go.fliplink.me/api/get-share-link/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Freigabe-Link abrufen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

GET/api/get-share-link/{flipbookId}

curl -X GET 'https://go.fliplink.me/api/get-share-link/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "URL": "https://go.fliplink.me/view/your-flipbook-slug"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Items — Ändern

Duplizieren

Erstellt eine oder mehrere serverseitige Kopien eines Flipbooks — jede Kopie erhält ihre eigene neue ID und Freigabe-URL. Du kannst bis zu 20 auf einmal duplizieren (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Duplizieren

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

Countnumber 1–500 (serverseitig begrenzt)

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

Countnumber1–500 (serverseitig begrenzt)

PDF ersetzen (Datei)

Multipart-Upload. Wird automatisch mit vorhandenem Vorder-/Rückteil neu zusammengeführt, falls angehängt.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→PDF ersetzen (Datei)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body (multipart/form-data)

Filefile —

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPDF ersetzen (URL)Vorder-/Rückseite festlegen (Datei)Vorder-/Rückseite entfernen PDF-URL abrufen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body (form-data)

Filefile

PDF ersetzen (URL)

Ersetzt die PDF eines vorhandenen Flipbooks durch eine, die der Server von einer von dir angegebenen URL herunterlädt. Das Flipbook behält seine ID, Einstellungen und seinen Freigabe-Link.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→PDF ersetzen (URL)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

FileURL z. B. https://example.com/new.pdf

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPDF ersetzen (Datei)Vorder-/Rückseite festlegen (URL)PDF-URL abrufen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

FileURL

Als Vorlage speichern (Umschalter)

Markiert das Flipbook als wiederverwendbare Vorlage (Status=true) oder entfernt es aus den Vorlagen (Status=false). Vorlagen erscheinen in list-templates und können neue Flipbooks vorbefüllen.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Als Vorlage speichern (Umschalter)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

Statustrue | false true/false. Standard ist true, wenn ausgelassen.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVorlagen auflisten Per Datei erstellen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Saved as template"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

Statustrue / falsetrue/false. Standard ist true, wenn ausgelassen.

Ordner zuweisen

Verschiebt das Flipbook zur Organisation in einen Ordner. Ordner werden bei Bedarf erstellt — weise einen Ordnernamen zu, der noch nicht existiert, und er wird automatisch angelegt (es gibt keinen separaten Aufruf zum Erstellen eines Ordners). Sende einen leeren Folder, um das Flipbook aus seinem Ordner zu entfernen. Ein Ordner existiert nur, solange mindestens ein Flipbook darin liegt — verschiebst du das letzte Flipbook heraus, verschwindet der Ordner aus list-folders. Ordnernamen dürfen / enthalten (z. B. Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Ordner zuweisen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

Folder Name des Ordners, in den das Flipbook verschoben werden soll — wird erstellt, falls er nicht existiert (oder verwende einen Namen aus list-folders). Sende leer, um die Zuweisung aufzuheben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtOrdner auflisten Teammitglied festlegen (erstellen oder aktualisieren)

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

FolderName des Ordners, in den das Flipbook verschoben werden soll — wird erstellt, falls er nicht existiert (oder verwende einen Namen aus list-folders). Sende leer, um die Zuweisung aufzuheben.

Vorder-/Rückseite festlegen (Datei)

Eines von beiden oder beide (Front/Back) optional — mindestens eines erforderlich. Wird mit der vorhandenen Haupt-PDF neu zusammengeführt.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Vorder-/Rückseite festlegen (Datei)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body (multipart/form-data)

`Front`file	—
`Back`file	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVorder-/Rückseite festlegen (URL)Vorder-/Rückseite entfernen PDF ersetzen (Datei)PDF-URL abrufen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body (form-data)

Frontfile

Backfile

Vorder-/Rückseite festlegen (URL)

URL-Variante von set-front-back-page — hängt Vorder-/Rückseiten von einer entfernten PDF-URL statt von einer hochgeladenen Datei an.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Vorder-/Rückseite festlegen (URL)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`Front`URL	z. B. `https://example.com/front.pdf`
`Back`URL	z. B. `https://example.com/back.pdf`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVorder-/Rückseite festlegen (Datei)Vorder-/Rückseite entfernen PDF-URL abrufen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

FrontURL

BackURL

Vorder-/Rückseite entfernen

Entfernt die Vorder-/Rückseiten-Umhüllung und stellt FilePDF auf die unumhüllte Kern-PDF (MiddlePDF) zurück. Idempotent — ein Flipbook ohne Umhüllung gibt OK zurück und ändert nichts. Gibt { Result, Message, URL (S3-URL der Kern-PDF) } zurück. Alte zusammengeführte/Vorder-/Rück-S3-Objekte werden nicht gelöscht.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Vorder-/Rückseite entfernen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVorder-/Rückseite festlegen (Datei)PDF-URL abrufen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Ablauf festlegen / Ablauf entfernen

Legt den automatischen Ablauf eines Flipbooks fest oder entfernt ihn. Sende Days + Hours als ganze Zahlen; Days=-1, Hours=0 entfernt den Ablauf vollständig.

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Ablauf festlegen / Ablauf entfernen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`Days`number	Verwende -1, um den Ablauf zu entfernen
`Hours`number	Optional, Standard 0

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtAnheften festlegen (Umschalter)Veröffentlichung festlegen (veröffentlichen / zurückziehen)

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

DaysnumberVerwende -1, um den Ablauf zu entfernen

HoursnumberOptional, Standard 0

Anheften festlegen (Umschalter)

Heftet das Flipbook an oder löst die Anheftung (der markierte Zustand), sodass es in deinem Dashboard nach oben sortiert wird.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Anheften festlegen (Umschalter)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtAuflisten

PUT/api/set-pin/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Items — Löschen

Löschen

Löscht den Datenbankeintrag des Flipbooks dauerhaft. Hinweis: Die zugrunde liegenden S3-Dateien werden NICHT automatisch entfernt.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Löschen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLeads löschen (massenweise)Auflisten

DELETE/api/delete/{flipbookId}

curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

CNAME (eigene Domains)

CNAME hinzufügen

Verknüpft eine bereits aktivierte eigene Domain (CNAME) mit einem Flipbook. Die Domain muss zuerst über das Web-Dashboard hinzugefügt und verifiziert werden (das stellt DNS + SSL bereit); dieser Endpunkt speichert nur die Bindung — er verifiziert kein DNS und stellt keine Zertifikate aus.

Voraussetzungen:
- Der CNAME muss bereits in deinem Konto existieren (über das Dashboard hinzugefügt). Andernfalls: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- Er muss innerhalb des CNAME-Limits deines Tarifs liegen.

Parameter:
- CNAME (erforderlich) — vollständiger Hostname, z. B. docs.example.com
- IsCloudflare (optional, Standard 0).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→CNAME hinzufügen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`CNAME`	z. B. `docs.example.com`
`IsCloudflare`true \| false	Optional. 0 (Standard) oder 1. Übergib 1, wenn deinem DNS der Proxy von Cloudflare vorgeschaltet ist.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtCNAMEs auflisten CNAME löschen Eigene URL festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

CNAME

IsCloudflaretrue / falseOptional. 0 (Standard) oder 1. Übergib 1, wenn deinem DNS der Proxy von Cloudflare vorgeschaltet ist.

CNAMEs auflisten

Alle eigenen CNAMEs des Aufrufers. Jedes Item: { CNAME, Documents (Anzahl aktiver Flipbooks), FlipbookIDs ([...] der aktiven Flipbook-IDs, die an diesen CNAME gebunden sind) }.

GEThttps://go.fliplink.me/api/list-cnames

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→CNAMEs auflisten

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtCNAME hinzufügen CNAME löschen

GET/api/list-cnames

curl -X GET 'https://go.fliplink.me/api/list-cnames' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

CNAME löschen

Entfernt die Bindung einer eigenen Domain (CNAME) von einem oder allen deiner Flipbooks. Zwei Modi:

Massenweise (Standard): übergib CNAME=<host> und lass FlipbookID leer — entfernt diesen CNAME von jedem Flipbook, das dir gehört.
Pro Flipbook: übergib FlipbookID=<id> — der CNAME wird von diesem Flipbook ermittelt. Verwende dies für eine zeilenweise Aktion „CNAME entfernen“.

Antwort (pro Flipbook): { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
Antwort (massenweise): { "Result": "OK", "Message": "CNAME removed successfully" }
Beide fehlen: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

Hinweis: Übergib den CNAME als Query-Parameter (nicht als URL-Segment), um Probleme mit Punkten im Hostnamen zu vermeiden.

DELETEhttps://go.fliplink.me/api/delete-cname

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→CNAMEs auflisten(den CNAME / die FlipbookID finden)→CNAME löschen

Query-Parameter

`CNAME`	Erforderlich im BULK-Modus (entfernt den CNAME von jedem Flipbook, das dir gehört). Wird ignoriert, wenn FlipbookID > 0 — der CNAME wird dann von diesem Flipbook übernommen.
`FlipbookID`number	Optional. Übergib eine Flipbook-ID > 0, um den CNAME von NUR diesem einen Flipbook zu entfernen (Pro-Flipbook-Modus). Lass leer/aus/0 für den Massenmodus (von allen entfernen).

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtCNAME hinzufügen CNAMEs auflisten

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

CNAMEErforderlich im BULK-Modus (entfernt den CNAME von jedem Flipbook, das dir gehört). Wird ignoriert, wenn FlipbookID > 0 — der CNAME wird dann von diesem Flipbook übernommen.

FlipbookIDnumberOptional. Übergib eine Flipbook-ID > 0, um den CNAME von NUR diesem einen Flipbook zu entfernen (Pro-Flipbook-Modus). Lass leer/aus/0 für den Massenmodus (von allen entfernen).

Ordner

Ordner auflisten

Listet deine Ordner auf, jeweils als { Folder (Name), URL (eine Ordner-GUID) }. Ordner werden aus Flipbook-Zuweisungen abgeleitet (erstellt über assign-to-folder), daher wird ein leerer Ordner nicht aufgeführt. Ordnernamen fließen in assign-to-folder (um ein Flipbook abzulegen) und set-team-member (um den Zugriff eines Teammitglieds einzuschränken) ein.

GEThttps://go.fliplink.me/api/list-folders

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Ordner auflisten

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtOrdner zuweisen Teammitglied festlegen (erstellen oder aktualisieren)

GET/api/list-folders

curl -X GET 'https://go.fliplink.me/api/list-folders' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Teammitglieder

Teammitglieder auflisten

Listet die Teammitglieder (Vendor-Benutzer) deines Kontos mit ihren Zugriffsdetails auf, einschließlich der Ordner, denen jedes Mitglied zugewiesen ist. Passwörter werden nie zurückgegeben. Filtern nach IsActive.

GEThttps://go.fliplink.me/api/list-team-members

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Teammitglieder auflisten

Query-Parameter

IsActivetrue | false 1=aktiv (Standard), 0=inaktiv

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtTeammitglied festlegen (erstellen oder aktualisieren)Teammitglied abrufen Teammitglied aktiv setzen Teammitglied löschen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

IsActivetrue / false1=aktiv (Standard), 0=inaktiv

Teammitglied abrufen

Gibt ein einzelnes Teammitglied anhand seiner Mitglieds-ID (der ID aus list-team-members) zurück — Name, E-Mail, Aktivstatus und die Ordner, denen das Mitglied zugewiesen ist. Ein Teammitglied ist auf die über set-team-member gesetzten Ordner (das Folders-Feld) beschränkt, sodass es nur auf Flipbooks innerhalb dieser Ordner zugreifen kann. Passwörter werden nie zurückgegeben. Die memberId ist die Teammitglieds-ID (aus List Team Members) — keine Flipbook-ID; eine Flipbook-ID gibt "Team member not found" zurück. Das Mitglied wird in ein Item-Objekt eingebettet zurückgegeben; Folders ist eine kommagetrennte Liste der Ordner, auf die es zugreifen kann (leer = keine Ordnerbeschränkung).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Teammitglied festlegen (erstellen oder aktualisieren)(zuerst ein Mitglied erstellen)→Teammitglied abrufen

Pfad-Parameter

memberIdnumber Teammitglieds-ID (aus list-team-members). KEINE Flipbook-ID.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtTeammitglieder auflisten Teammitglied festlegen (erstellen oder aktualisieren)Ordner auflisten

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

memberIdrequirednumberTeammitglieds-ID (aus list-team-members). KEINE Flipbook-ID.

Teammitglied festlegen (erstellen oder aktualisieren)

Erstellt ein neues Teammitglied (Vendor-Benutzer) oder aktualisiert ein bestehendes — steuert, wer auf dein Konto zugreifen darf, und über das Folders-Feld, auf welche Ordner es beschränkt ist (ein Mitglied sieht nur Flipbooks innerhalb seiner zugewiesenen Ordner). Bei Erfolg wird ein Audit-Log-Eintrag geschrieben.

Häufige Fehler: Der Name des Mitglieds ist ein einzelnes Name-Feld — es gibt kein FirstName/LastName. Folders ist eine kommagetrennte Liste von Ordnernamen aus List Folders (z. B. Marketing,Sales); lass es leer für keine Ordnerbeschränkung. Das Erstellen eines Mitglieds gibt { Result:"OK", Message:"Team member created" } zurück (der Aktualisierungspfad — wenn ID angegeben ist — gibt "Updated successfully" zurück). Die E-Mail des Mitglieds darf noch keinem FlipLink-Benutzer gehören, und mit + aliasierte E-Mails werden abgelehnt.

POSThttps://go.fliplink.me/api/set-team-member

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Ordner auflisten(Namen für den Folders-Geltungsbereich)→Teammitglied festlegen (erstellen oder aktualisieren)

Body-Parameter

`Name`	z. B. `Jane`
`Email`email	z. B. `jane@example.com`
`ID`number	Auslassen oder -1 zum Erstellen. >0 zum Aktualisieren.
`Password`	Klartext; serverseitig verschlüsselt. Leer bei Aktualisierung behält das bestehende bei.
`ProfileImage`URL	—
`Folders`	Ordner, auf die dieses Mitglied beschränkt ist — eine getrennte Liste von Ordnernamen (aus list-folders). Das Mitglied kann nur auf Flipbooks innerhalb dieser Ordner zugreifen.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtTeammitglieder auflisten Teammitglied abrufen Teammitglied aktiv setzen Teammitglied löschen Ordner auflisten

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Team member created"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Body-Parameter

Name

Emailemail

IDnumberAuslassen oder -1 zum Erstellen. >0 zum Aktualisieren.

PasswordKlartext; serverseitig verschlüsselt. Leer bei Aktualisierung behält das bestehende bei.

ProfileImageURL

FoldersOrdner, auf die dieses Mitglied beschränkt ist — eine getrennte Liste von Ordnernamen (aus list-folders). Das Mitglied kann nur auf Flipbooks innerhalb dieser Ordner zugreifen.

Teammitglied aktiv setzen

Aktiviert oder deaktiviert ein Teammitglied und steuert damit, ob es sich anmelden und auf das Konto zugreifen kann.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Teammitglied festlegen (erstellen oder aktualisieren)(zuerst ein Mitglied erstellen)→Teammitglied aktiv setzen

Pfad-Parameter

memberIdnumber Teammitglieds-ID (aus list-team-members). KEINE Flipbook-ID.

Body-Parameter

IsActivetrue | false z. B. true

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtTeammitglieder auflisten Teammitglied festlegen (erstellen oder aktualisieren)Teammitglied löschen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

memberIdrequirednumberTeammitglieds-ID (aus list-team-members). KEINE Flipbook-ID.

Body-Parameter

IsActivetrue / false

Teammitglied löschen

Soft-Delete (Deaktivierung). Teammitglieder werden nie endgültig gelöscht — dies deaktiviert das Mitglied (ein REST-Alias für set-team-member-active mit IsActive=false). Ihr Zahlungsverlauf und ihre Audit-Verweise bleiben erhalten, und sie können später über PUT /api/set-team-member-active (IsActive=true) reaktiviert werden.

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

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Teammitglied festlegen (erstellen oder aktualisieren)(zuerst ein Mitglied erstellen)→Teammitglied löschen

Pfad-Parameter

memberIdnumber Teammitglieds-ID (aus list-team-members). KEINE Flipbook-ID.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtTeammitglied aktiv setzen Teammitglieder auflisten

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'

Beispielantwort200 OK

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

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

memberIdrequirednumberTeammitglieds-ID (aus list-team-members). KEINE Flipbook-ID.

Leads & Verkäufe

Leads auflisten

Listet die Lead-Capture-Einsendungen auf, die deine Flipbooks gesammelt haben. Gibt Items[] plus ein dynamisches Columns[]-Schema (zum Rendern einer Tabelle) und TotalRecordCount zurück. Unterstützt Paginierung und CSV-Export über IsDownload.

GEThttps://go.fliplink.me/api/list-leads

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Leads auflisten

Query-Parameter

`ItemIDs`	Mit Komma ODER Pipe getrennte Flipbook-IDs (leer = alle)
`SearchText`	—
`PageNo`number	z. B. `1`
`Offset`number	z. B. `0`
`IsDownload`true \| false	z. B. `true`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead löschen Leads löschen (massenweise)Lead-Erfassung festlegen (Basis)

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'

Beispielantwort200 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
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

ItemIDsMit Komma ODER Pipe getrennte Flipbook-IDs (leer = alle)

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

Verkäufe auflisten

Listet Verkaufs-/Kaufdatensätze für deine Flipbooks auf (Käufer-E-Mail, Flipbook, Betrag, Datum) plus die Spaltendefinitionen für die Verkaufstabelle. Unterstützt Paginierung und CSV-Export über IsDownload.

GEThttps://go.fliplink.me/api/list-sales

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Verkäufe auflisten

Query-Parameter

`ItemIDs`	—
`SearchText`	—
`PageNo`number	z. B. `1`
`Offset`number	z. B. `0`
`IsDownload`true \| false	z. B. `true`
`IsAbandoned`true \| false	true → gibt Verkäufe abgebrochener Warenkörbe statt abgeschlossener Verkäufe zurück

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVerkaufseinstellungen festlegen Flipbook-Kauf festlegen

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'

Beispielantwort200 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
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

ItemIDs

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

IsAbandonedtrue / falsetrue → gibt Verkäufe abgebrochener Warenkörbe statt abgeschlossener Verkäufe zurück

Lead löschen

Löscht einen einzelnen erfassten Lead anhand seiner ID. Das Pfadsegment ist die leadId; übergib außerdem die Email des Leads und seine FlipbookID als Query-Parameter.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Leads auflisten(eine Lead-ID beschaffen)→Lead löschen

Pfad-Parameter

leadIdnumber Die ID des Leads (die LeadID aus list-leads).

Query-Parameter

`Email`email	z. B. `foo@example.com`
`FlipbookID`number	z. B. `{{flipbookId}}`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLeads auflisten Leads löschen (massenweise)

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

leadIdrequirednumberDie ID des Leads (die LeadID aus list-leads).

Query-Parameter

Emailemail

FlipbookIDnumber

Leads löschen (massenweise)

Massenweises Löschen von Leads nach Filter. Mindestens EINES von FlipbookID/Email/DateFrom/DateTo ist ERFORDERLICH — ein Aufruf ohne Filter wird abgelehnt (es gibt keinen Pfad zum Löschen aller). Immer Vendor-bezogen. Gibt { Result, Deleted (Anzahl) } zurück. Bereinigt auch untergeordnete Zeilen (View-Log / CTA-Klicks / Sheet-Export-Log).

DELETEhttps://go.fliplink.me/api/delete-leads

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(nach FlipbookID einschränken)→Leads löschen (massenweise)

Query-Parameter

`FlipbookID`number	Optional. Lösche Leads nur auf diesem Flipbook.
`Email`email	Optional. EXAKT übereinstimmende E-Mail.
`DateFrom`	Optional. Lösche Leads, die an/nach diesem Datum erfasst wurden (entspricht Lead.CreatedOn). Jedes parsebare Datum, z. B. 2026-01-01 oder 2026-01-01T00:00:00Z.
`DateTo`	Optional. Lösche Leads, die an/vor diesem Datum erfasst wurden.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLeads auflisten Lead löschen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

FlipbookIDnumberOptional. Lösche Leads nur auf diesem Flipbook.

EmailemailOptional. EXAKT übereinstimmende E-Mail.

DateFromOptional. Lösche Leads, die an/nach diesem Datum erfasst wurden (entspricht Lead.CreatedOn). Jedes parsebare Datum, z. B. 2026-01-01 oder 2026-01-01T00:00:00Z.

DateToOptional. Lösche Leads, die an/vor diesem Datum erfasst wurden.

Flipbook-Kauf festlegen

Erfasst einen abgeschlossenen Flipbook-Verkauf (Kauf) — verwende es, um Käufe zu protokollieren, die über deinen eigenen Zahlungsablauf getätigt wurden, ohne den Stripe-Checkout von FlipLink zu durchlaufen.

Pfad-Parameter: {flipbookId} — das Flipbook, das als gekauft markiert wird.

Body (urlencoded):
- Email — E-Mail des Käufers (erforderlich)
- PaymentRef — die Referenz deines Payment-Gateways, z. B. eine Stripe-PaymentIntent-ID (erforderlich)

Antwort (Erfolg): { "Result": "OK", "Message": "Purchase recorded successfully" }
Antwort (Fehler): { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

Häufige Fehler: Sende PaymentRef; sende NICHT Amount/Currency — diese werden serverseitig aus deiner Zahlungsreferenz abgeleitet.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Flipbook-Kauf festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`Email`email	E-Mail-Adresse des Käufers (erforderlich).
`PaymentRef`	Payment-Intent-Referenz vom Gateway (erforderlich). Bei Stripe ist dies die PaymentIntent-ID (`pi_...`).

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVerkaufseinstellungen festlegen Verkaufs-Gateway festlegen Verkäufe auflisten

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

EmailemailE-Mail-Adresse des Käufers (erforderlich).

PaymentRefPayment-Intent-Referenz vom Gateway (erforderlich). Bei Stripe ist dies die PaymentIntent-ID (`pi_...`).

Nachschlagewerte

Vorlagen auflisten

Listet die wiederverwendbaren Flipbook-Vorlagen auf, die in deinem Konto gespeichert sind. Filtern nach DocType (0 = alle). Verwende die ID einer Vorlage mit save-as-template / den Erstell-Abläufen.

GEThttps://go.fliplink.me/api/list-templates

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Vorlagen auflisten

Query-Parameter

DocTypenumber 0 = Flipbook (Standard), 1 = Dokument

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtAls Vorlage speichern (Umschalter)Per Datei erstellen

GET/api/list-templates

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

DocTypenumber0 = Flipbook (Standard), 1 = Dokument

Skins auflisten

Listet die verfügbaren Viewer-Skins/-Themes auf; jede Zeile enthält die gebündelte Hintergrund-URL des Skins. Verwende den Namen eines Skins mit set-skin.

GEThttps://go.fliplink.me/api/list-skins

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Skins auflisten

Query-Parameter

Typetrue | false 0=Flipbook-Skins, 1=Dokument-Skins

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtSkin festlegen

GET/api/list-skins

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 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"
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Query-Parameter

Typetrue / false0=Flipbook-Skins, 1=Dokument-Skins

Währungen auflisten

Listet die Währungen auf, die beim Verkauf eines Flipbooks verfügbar sind (für die Verkaufs-/Checkout-Einstellungen).

GEThttps://go.fliplink.me/api/list-currencies

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Währungen auflisten

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVerkaufseinstellungen festlegen

GET/api/list-currencies

curl -X GET 'https://go.fliplink.me/api/list-currencies' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Hintergrundmusik auflisten

Listet die integrierten Hintergrundmusik-Titel auf, die du an einen Flipbook-Viewer anhängen kannst.

GEThttps://go.fliplink.me/api/list-background-music

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Hintergrundmusik auflisten

Keine Parameter.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtHintergrundmusik festlegen

GET/api/list-background-music

curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Bereiche — Branding & Inhalt

Meta festlegen

Legt den Titel und die SEO-Metadaten des Flipbooks fest — Title, Description, TitleColor und das IsPublished-Flag.

Hinweis: Dies überschreibt Title/Description/TitleColor. Um nur den Veröffentlichungsstatus zu ändern, verwende set-published.

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Meta festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`Title`	—
`Description`	—
`TitleColor`	—
`IsPublished`true \| false	z. B. `false`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVeröffentlichung festlegen (veröffentlichen / zurückziehen)

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

Title

Description

TitleColor

IsPublishedtrue / false

Veröffentlichung festlegen (veröffentlichen / zurückziehen)

Veröffentlicht das Flipbook oder zieht es zurück — ändert NUR das Veröffentlichungs-Flag und lässt Title/Description/TitleColor unverändert (anders als set-meta). Verwende es, um ein Flipbook (erneut) zu veröffentlichen, z. B. eines, das von create-by-file unveröffentlicht zurückkam.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Veröffentlichung festlegen (veröffentlichen / zurückziehen)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsPublishedtrue | false true/1 = veröffentlichen, false/0 = zurückziehen (erforderlich).

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtMeta festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsPublishedtrue / falsetrue/1 = veröffentlichen, false/0 = zurückziehen (erforderlich).

Skin festlegen

Wendet einen Viewer-Skin/-Theme auf das Flipbook an; der Server löst den Skin-Namen zu seiner ID auf.

Häufige Fehler: Das Feld ist SkinName (der String aus list-skins), keine numerische ID.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Skins auflisten(einen SkinName auswählen)→Skin festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

SkinName Aus /api/list-skins → Spalte Name

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtSkins auflisten

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

SkinNameAus /api/list-skins → Spalte Name

Logo festlegen

Legt das Logobild fest, das im Header-/Branding-Bereich des Flipbook-Viewers angezeigt wird.

PUThttps://go.fliplink.me/api/set-logo/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Logo festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`LogoIMG`URL	—
`LogoURL`URL	—
`IsShowLogoMobile`true \| false	z. B. `false`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtFavicon festlegen Hintergrundbild festlegen

PUT/api/set-logo/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-logo/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LogoIMG=<LogoIMG>' \
  --data-urlencode 'LogoURL=<LogoURL>' \
  --data-urlencode 'IsShowLogoMobile=false'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

LogoIMGURL

LogoURLURL

IsShowLogoMobiletrue / false

Hintergrundbild festlegen

Legt das Hintergrundbild des Viewers aus einer von dir angegebenen URL fest (es gibt keine integrierte Galerie).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Hintergrundbild festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

BackgroundIMGURL Bild-URL ODER Platzhalter-URL wie https://plchldr.co/i/100x100?text=&bg=HEX

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

BackgroundIMGURLBild-URL ODER Platzhalter-URL wie https://plchldr.co/i/100x100?text=&bg=HEX

Favicon festlegen

Legt das Favicon (Browser-Tab-Symbol) fest, das die gehostete Viewer-Seite des Flipbooks verwendet.

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Favicon festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

FaviconIMGURL —

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLogo festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

FaviconIMGURL

Seitendarstellung festlegen

Konfiguriert die Seitendarstellung des Viewers — Hintergrund, Seitenschatten, Abstände und zugehörige Optionen für Aussehen und Wirkung. Werte werden wortwörtlich gespeichert; ältere Items können beim Auslesen über Get one andere Werte melden (z. B. regular oder numerisch 1).

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Seitendarstellung festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`PageDepth`enum	flat \| thin \| thickEines von: `flat`, `thin`, `thick`
`CoverType`enum	soft \| hardEines von: `soft`, `hard`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLeser-Navigation festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

PageDepthchoose oneflat | thin | thick

CoverTypechoose onesoft | hard

Ladetext festlegen

Legt den benutzerdefinierten Text fest, der auf dem Ladebildschirm des Viewers angezeigt wird.

Häufige Fehler: Das Feld ist CustomLoadingText, nicht LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Ladetext festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

CustomLoadingText —

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

CustomLoadingText

Eigene URL festlegen

Legt den benutzerdefinierten (Vanity-)Slug für die Freigabe-URL des Flipbooks fest. Muss eindeutig sein; ein bereits verwendeter Slug gibt Result:ERROR zurück.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Eigene URL festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

CustomURL —

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtFreigabe-Link abrufen CNAME hinzufügen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

CustomURL

Vorschau-PDF festlegen

Legt die Vorschau-PDF fest, die Lesern vor der Lead-Erfassung / Zahlung angezeigt wird. Wird automatisch entfernt, wenn sowohl Lead-Erfassung als auch Verkaufsmodus aus sind.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Vorschau-PDF festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

PreviewPDFURL —

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtBild-PDF festlegen Lead-Erfassung festlegen (Basis)Verkaufseinstellungen festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

PreviewPDFURL

Bild-PDF festlegen

Legt die reine Bild-/Vorschau-PDF fest, die für Thumbnails und Vorschauen verwendet wird. Sende leer, um die vorhandene Bild-PDF beizubehalten.

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Bild-PDF festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IMGPdfURL —

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVorschau-PDF festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IMGPdfURL

Bereiche — Viewer & Leser

Viewer-Steuerung festlegen

Zeigt oder verbirgt einzelne Schaltflächen der Viewer-Symbolleiste (Download, Drucken, Teilen, Vollbild, Zoom, Thumbnails usw.).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Viewer-Steuerung festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsShowControls`true \| false	z. B. `true`
`IsPrint`true \| false	z. B. `false`
`IsDownload`true \| false	z. B. `false`
`IsThumbnails`true \| false	z. B. `true`
`IsSearch`true \| false	z. B. `true`
`IsSound`true \| false	z. B. `true`
`IsFullscreen`true \| false	z. B. `true`
`IsZoom`true \| false	z. B. `true`
`IsNotes`true \| false	z. B. `false`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLeser-Navigation festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsShowControlstrue / false

IsPrinttrue / false

IsDownloadtrue / false

IsThumbnailstrue / false

IsSearchtrue / false

IsSoundtrue / false

IsFullscreentrue / false

IsZoomtrue / false

IsNotestrue / false

Leser-Navigation festlegen

Konfiguriert die Leser-Navigation im Viewer — Seiten-Thumbnails, Inhaltsverzeichnis und wie Leser zwischen Seiten wechseln.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Leser-Navigation festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsNavFirstLast`true \| false	z. B. `true`
`BookLayout`enum	1=einzeln, 2=doppeltEines von: `1`, `2`
`IsRightToLeft`true \| false	z. B. `false`
`ScrollBehaviour`number	Numerischer Scroll-Modus

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtViewer-Steuerung festlegen Auto-Flip festlegen Seitendarstellung festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsNavFirstLasttrue / false

BookLayoutchoose one1=einzeln, 2=doppelt

IsRightToLefttrue / false

ScrollBehaviournumberNumerischer Scroll-Modus

Auto-Flip festlegen

Aktiviert oder deaktiviert das automatische Umblättern im Viewer und legt dessen Intervall fest.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Auto-Flip festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

AutoFlipInSecsnumber MILLISEKUNDEN trotz des Namens. 0 = aus, 3000 = 3 s, 5000 = 5 s usw.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLeser-Navigation festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

AutoFlipInSecsnumberMILLISEKUNDEN trotz des Namens. 0 = aus, 3000 = 3 s, 5000 = 5 s usw.

Hintergrundmusik festlegen

Legt den Hintergrundmusik-Titel fest, der im Viewer abgespielt wird, oder entfernt ihn. Verfügbare Titel siehe list-background-music.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Hintergrundmusik auflisten(einen Titel auswählen)→Hintergrundmusik festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`BackgroundMusic`	Vordefinierter Titel-Dateiname (aus /api/list-background-music)
`BackgroundMusicCustom`URL	URL eigener hochgeladener Musik
`IsBackgroundMusicLoop`true \| false	z. B. `false`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtHintergrundmusik auflisten

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

BackgroundMusicVordefinierter Titel-Dateiname (aus /api/list-background-music)

BackgroundMusicCustomURLURL eigener hochgeladener Musik

IsBackgroundMusicLooptrue / false

Kopf-/Fußzeilen-Layout festlegen

Legt den Inhalt fest, der in den vier Ecken (Kopf-/Fußzeile) des Viewer-Rahmens angezeigt wird.

PUThttps://go.fliplink.me/api/set-header-footer-layout/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Kopf-/Fußzeilen-Layout festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`TopLeft`	—
`TopRight`	—
`BottomLeft`	—
`BottomRight`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

PUT/api/set-header-footer-layout/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=<TopLeft>' \
  --data-urlencode 'TopRight=<TopRight>' \
  --data-urlencode 'BottomLeft=<BottomLeft>' \
  --data-urlencode 'BottomRight=<BottomRight>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

TopLeft

TopRight

BottomLeft

BottomRight

Bereiche — CTAs

Primären CTA festlegen

Konfiguriert die primäre Call-to-Action-Schaltfläche im Viewer (Beschriftung, URL, Position, Farbe).

Häufige Fehler: Die Felder sind IsCTAButton, CTAButtonText, CTAButtonURL (plus Position/Farbe) — nicht Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Primären CTA festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsCTAButton`true \| false	z. B. `false`
`CTAButtonText`	—
`CTAButtonColor`	—
`CTAButtonURL`URL	Präfixe mailto: / tel: werden serverseitig automatisch normalisiert
`CTAButtonTextColor`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtSekundären CTA festlegen CTA-Vorschauregeln festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsCTAButtontrue / false

CTAButtonText

CTAButtonColor

CTAButtonURLURLPräfixe mailto: / tel: werden serverseitig automatisch normalisiert

CTAButtonTextColor

Sekundären CTA festlegen

Konfiguriert die sekundäre Call-to-Action-Schaltfläche im Viewer.

Häufige Fehler: Die sekundäre Schaltfläche verwendet die mit 2 versehenen Felder — IsCTAButton2, CTAButtonText2, CTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Sekundären CTA festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsCTAButton2`true \| false	z. B. `false`
`CTAButtonText2`	—
`CTAButtonColor2`	—
`CTAButtonTextColor2`	—
`CTAButtonURL2`URL	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPrimären CTA festlegen CTA-Vorschauregeln festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsCTAButton2true / false

CTAButtonText2

CTAButtonColor2

CTAButtonTextColor2

CTAButtonURL2URL

CTA-Vorschauregeln festlegen

Konfiguriert, wann der Call-to-Action den Lesern angezeigt wird — z. B. nach N Seiten oder N Sekunden (die Vorschau-Gate-Regeln).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→CTA-Vorschauregeln festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsCTAHiddenInPreviewtrue | false z. B. false

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPrimären CTA festlegen Lead-Erfassung festlegen (Basis)

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsCTAHiddenInPreviewtrue / false

Bereiche — Zugriffskontrolle

Passwortzugriff festlegen

Schaltet den Passwortschutz für das Flipbook ein/aus und legt das Zugriffspasswort fest.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Passwortzugriff festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsPasswordProtected`true \| false	z. B. `false`
`Password`	—
`PwdTitle`	—
`PwdPlaceholder`	—
`PwdButton`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsPasswordProtectedtrue / false

Password

PwdTitle

PwdPlaceholder

PwdButton

Indexierung festlegen

Steuert die Suchmaschinen-Indexierung des gehosteten Flipbooks. IsNoIndex=true fügt ein robots-noindex hinzu, sodass die Seite nicht indexiert wird.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Indexierung festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsNoIndextrue | false z. B. false

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsNoIndextrue / false

E-Mail-Zulassungsliste festlegen

Beschränkt den Viewer-Zugriff auf eine Liste zugelassener E-Mail-Adressen (geschütztes Ansehen).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→E-Mail-Zulassungsliste festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

EmailsAllowed Getrennte Liste zugelassener E-Mails

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtPasswortzugriff festlegen Lead-Verifizierung festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

EmailsAllowedGetrennte Liste zugelassener E-Mails

Bereiche — Lead-Erfassung

Lead-Erfassung festlegen (Basis)

Aktiviert und konfiguriert das Basis-Lead-Erfassungsformular (das Gate, das vor dem Lesen die Details des Betrachters sammelt).

Häufige Fehler: Das Aktivierungs-Flag ist IsLeadCapture, nicht IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsLeadCapture`true \| false	z. B. `false`
`LeadCaptureTitle`	—
`IsLeadAllowSkip`true \| false	z. B. `false`
`LeadSkipText`	—
`LeadFormAfterPages`number	z. B. `0`
`LeadAfterPages`number	z. B. `0`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Felder festlegen Eigene Lead-Felder festlegen Lead-Beschriftungen festlegen Lead-Datenschutz festlegen Lead-Verifizierung festlegen Lead-Webhook festlegen Lead-Google-Sheets festlegen Leads auflisten

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsLeadCapturetrue / false

LeadCaptureTitle

IsLeadAllowSkiptrue / false

LeadSkipText

LeadFormAfterPagesnumber

LeadAfterPagesnumber

Lead-Felder festlegen

Schaltet jedes Standard-Lead-Erfassungsfeld um (Name, E-Mail, Telefon, Firma usw.) und legt fest, ob es Pflicht ist.

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)(Lead-Erfassung aktivieren)→Lead-Felder festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsLeadEmail`true \| false	z. B. `true`
`IsLeadEmailMandatory`true \| false	z. B. `true`
`IsLeadName`true \| false	z. B. `true`
`IsLeadNameMandatory`true \| false	z. B. `false`
`IsLeadPhone`true \| false	z. B. `false`
`IsLeadPhoneMandatory`true \| false	z. B. `false`
`IsLeadCompany`true \| false	z. B. `false`
`IsLeadCompanyMandatory`true \| false	z. B. `false`
`IsLeadDate`true \| false	z. B. `false`
`IsLeadDateMandatory`true \| false	z. B. `false`
`LeadPhoneCountry`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Erfassung festlegen (Basis)Eigene Lead-Felder festlegen Lead-Beschriftungen festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsLeadEmailtrue / false

IsLeadEmailMandatorytrue / false

IsLeadNametrue / false

IsLeadNameMandatorytrue / false

IsLeadPhonetrue / false

IsLeadPhoneMandatorytrue / false

IsLeadCompanytrue / false

IsLeadCompanyMandatorytrue / false

IsLeadDatetrue / false

IsLeadDateMandatorytrue / false

LeadPhoneCountry

Eigene Lead-Felder festlegen

Definiert zusätzliche eigene Felder im Lead-Erfassungsformular über die Standardfelder Name/E-Mail/Telefon hinaus.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)(Lead-Erfassung aktivieren)→Eigene Lead-Felder festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsLeadCustom1`true \| false	z. B. `false`
`IsLeadCustom1Mandatory`true \| false	z. B. `false`
`Custom1Label`	—
`IsLeadCustom2`true \| false	z. B. `false`
`IsLeadCustom2Mandatory`true \| false	z. B. `false`
`Custom2Label`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Felder festlegen Lead-Beschriftungen festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsLeadCustom1true / false

IsLeadCustom1Mandatorytrue / false

Custom1Label

IsLeadCustom2true / false

IsLeadCustom2Mandatorytrue / false

Custom2Label

Lead-Beschriftungen festlegen

Legt die Anzeigebeschriftungen und Platzhaltertexte für die Felder des Lead-Erfassungsformulars fest.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)(Lead-Erfassung aktivieren)→Lead-Beschriftungen festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`LeadEmail`email	—
`LeadName`	—
`LeadPhone`phone	—
`LeadCompany`	—
`LeadDate`	—
`LeadButton`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Felder festlegen Eigene Lead-Felder festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

LeadEmailemail

LeadName

LeadPhonephone

LeadCompany

LeadDate

LeadButton

Lead-Datenschutz festlegen

Konfiguriert den Datenschutz-/Einwilligungstext und die Optionen der Lead-Erfassung (z. B. die DSGVO-Einwilligungs-Checkbox).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)(Lead-Erfassung aktivieren)→Lead-Datenschutz festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsLeadPrivacyPolicy`true \| false	z. B. `false`
`PrivacyPolicyURL`URL	—
`PrivacyPolicyText`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Erfassung festlegen (Basis)

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsLeadPrivacyPolicytrue / false

PrivacyPolicyURLURL

PrivacyPolicyText

Lead-Verifizierung festlegen

Schaltet die E-Mail-Verifizierung von Leads ein oder aus und verlangt von Betrachtern, ihre E-Mail vor dem Zugriff zu bestätigen.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)(Lead-Erfassung aktivieren)→Lead-Verifizierung festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsVerifyEmail`true \| false	z. B. `false`
`IsVerifyMobile`true \| false	z. B. `false`
`TwillioAPIKey`	Dein Twilio-API-Schlüssel (der Feldname behält die ursprüngliche Schreibweise 'Twillio').
`EmailVerifyTitleText`	—
`EmailVerifyButtonText`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Erfassung festlegen (Basis)

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsVerifyEmailtrue / false

IsVerifyMobiletrue / false

TwillioAPIKeyDein Twilio-API-Schlüssel (der Feldname behält die ursprüngliche Schreibweise 'Twillio').

EmailVerifyTitleText

EmailVerifyButtonText

Lead-Webhook festlegen

Legt eine Webhook-URL fest, die jeden neuen Lead empfängt (gespeichert als New-Lead-Webhook). Verwende test-webhook, um zu prüfen, ob er ausgelöst wird.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)(Lead-Erfassung aktivieren)→Lead-Webhook festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

WebhookURL_NewLeadURL Deine Endpunkt-URL — empfängt für jeden neuen Lead eine JSON-Payload.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtWebhook testen Leads auflisten Lead-Google-Sheets festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

WebhookURL_NewLeadURLDeine Endpunkt-URL — empfängt für jeden neuen Lead eine JSON-Payload.

Webhook testen

Sendet eine TEST-Payload an den konfigurierten Lead-Webhook des Flipbooks, damit du das Auslieferungsformat ohne echten Lead prüfen kannst. Gibt ERROR 'No lead webhook is configured for this flipbook.' zurück, wenn keiner gesetzt ist. Die Payload-Struktur entspricht einem echten Lead (Schlüssel: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2), enthält aber Dummy-Werte (pdf_id:"-1", pdf_name:"Test PDF", ...). Es wird kein echter Lead gespeichert und keine Benachrichtigungs-E-Mail gesendet.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Webhook festlegen(zuerst muss ein Webhook konfiguriert werden)→Webhook testen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Webhook festlegen

POST/api/test-webhook/{flipbookId}

curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Lead-Google-Sheets festlegen

Verbindet die Lead-Erfassung mit einem Google Sheet — neue Leads werden an das von dir angegebene Sheet angehängt (Sheet-ID + Name).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Lead-Erfassung festlegen (Basis)(Lead-Erfassung aktivieren)→Lead-Google-Sheets festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`GoogleSheetURL`URL	—
`GoogleSheetIDKey`	—
`GoogleSheetName`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtLead-Webhook festlegen Leads auflisten

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

GoogleSheetURLURL

GoogleSheetIDKey

GoogleSheetName

Bereiche — Benachrichtigungen & E-Mail-Vorlagen

Benachrichtigungen festlegen

Konfiguriert, welche E-Mail-Benachrichtigungen du für dieses Flipbook erhältst (neuer Lead, neuer View, neuer Verkauf).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Benachrichtigungen festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`NotificationsEmail`email	—
`IsSendEmailOnView`true \| false	z. B. `false`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

NotificationsEmailemail

IsSendEmailOnViewtrue / false

E-Mail-Vorlage festlegen — Neuer Lead

Legt die E-Mail fest, die bei einem New-Lead-Ereignis gesendet wird. Sende leere Werte, um die Standardvorlage NEW_LEAD wiederherzustellen.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→E-Mail-Vorlage festlegen — Neuer Lead

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`EmailLeadSubject`	—
`EmailLeadBody`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtBenachrichtigungen festlegen Lead-Erfassung festlegen (Basis)

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

EmailLeadSubject

EmailLeadBody

E-Mail-Vorlage festlegen — Neuer View

Legt die E-Mail-Vorlage fest, die bei einer New-View-Benachrichtigung gesendet wird. Sende leer, um die Standardvorlage NEW_VIEW wiederherzustellen.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→E-Mail-Vorlage festlegen — Neuer View

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`EmailViewSubject`	—
`EmailViewBody`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtBenachrichtigungen festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

EmailViewSubject

EmailViewBody

E-Mail-Vorlage festlegen — Neuer Verkauf

Legt die E-Mail-Vorlage fest, die bei einer New-Sale-Benachrichtigung gesendet wird. Sende leer, um die Standardvorlage NEW_SALE wiederherzustellen.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→E-Mail-Vorlage festlegen — Neuer Verkauf

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`EmailSaleSubject`	—
`EmailSaleBody`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtBenachrichtigungen festlegen Verkaufseinstellungen festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

EmailSaleSubject

EmailSaleBody

Bereiche — Verkäufe

Verkaufseinstellungen festlegen

Konfiguriert den Verkauf des Flipbooks (Preis, Währung, Optionen). Das Aktivieren des Verkaufsmodus aktiviert automatisch die E-Mail-Verifizierung und macht die Lead-E-Mail zur Pflicht.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Währungen auflisten(SaleCurr auswählen)→Verkaufseinstellungen festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsForSale`true \| false	z. B. `false`
`SaleCurr`	Aus /api/list-currencies
`SaleAmount`number	z. B. `0`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtWährungen auflisten Verkaufsseiten-Text festlegen Verkaufs-Gateway festlegen Flipbook-Kauf festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsForSaletrue / false

SaleCurrAus /api/list-currencies

SaleAmountnumber

Verkaufsseiten-Text festlegen

Legt den Marketingtext fest, der auf der Verkaufs-/Checkout-Seite des Flipbooks angezeigt wird.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Verkaufseinstellungen festlegen(Verkauf aktivieren)→Verkaufsseiten-Text festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`SalePageTitle`	—
`SaleAccessPageTitle`	—
`SalePurchaseButtonText`	—
`SaleButtonText`	—
`SaleAccessButtonText`	—
`SaleButtonColor`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVerkaufseinstellungen festlegen Verkaufs-Gateway festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

SalePageTitle

SaleAccessPageTitle

SalePurchaseButtonText

SaleButtonText

SaleAccessButtonText

SaleButtonColor

Verkaufs-Gateway festlegen

Wählt und konfiguriert das Payment-Gateway, das beim Verkauf dieses Flipbooks verwendet wird.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Verkaufseinstellungen festlegen(Verkauf aktivieren)→Verkaufs-Gateway festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`SaleGatewayName`	—
`SaleGatewayKey`	—
`SaleGatewaySecret`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVerkaufseinstellungen festlegen Flipbook-Kauf festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

SaleGatewayName

SaleGatewayKey

SaleGatewaySecret

Bereiche — Freigabe

Freigabe-Button festlegen

Fügt dem Viewer einen Button für Freigabeanfragen hinzu. Das Aktivieren löst den Freigabeanfrage-Workflow aus.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(DocType=document — nur Document-Items)→Freigabe-Button festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsApprovalButton`true \| false	z. B. `false`
`ApprovalButtonText`	—
`ApprovalButtonColor`	—
`ApprovalButtonTextColor`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtFreigabe-E-Mail-Vorlagen festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsApprovalButtontrue / false

ApprovalButtonText

ApprovalButtonColor

ApprovalButtonTextColor

Freigabe-E-Mail-Vorlagen festlegen

Legt die E-Mail-Vorlagen fest, die vom Freigabe-Workflow verwendet werden. Leere Werte ziehen die Standardvorlagen heran.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(DocType=document — nur Document-Items)→Freigabe-E-Mail-Vorlagen festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`EmailApproveRequestSubject`	—
`EmailApproveRequestBody`	—
`EmailApproveRemindSubject`	—
`EmailApproveRemindBody`	—
`EmailApproveSubmitSubject`	—
`EmailApproveSubmitBody`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtFreigabe-Button festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

EmailApproveRequestSubject

EmailApproveRequestBody

EmailApproveRemindSubject

EmailApproveRemindBody

EmailApproveSubmitSubject

EmailApproveSubmitBody

Bereiche — Teilen

Teilen-Hauptschalter festlegen

Haupt-Ein-/Ausschalter für die Teilen-Buttons im Viewer.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Teilen-Hauptschalter festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsShareButtonstrue | false z. B. false

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtTeilen-Kanäle festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsShareButtonstrue / false

Teilen-Kanäle festlegen

Schaltet jeden sozialen Teilen-Kanal (Facebook, X, LinkedIn, WhatsApp, E-Mail usw.) einzeln im Teilen-Menü des Viewers um.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Teilen-Kanäle festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsShareFacebook`true \| false	z. B. `true`
`IsShareTwitter`true \| false	z. B. `true`
`IsShareWhatsApp`true \| false	z. B. `true`
`IsShareTelegram`true \| false	z. B. `false`
`IsShareLinkedIn`true \| false	z. B. `true`
`IsSharePinterest`true \| false	z. B. `false`
`IsShareReddit`true \| false	z. B. `false`
`IsShareTumblr`true \| false	z. B. `false`
`IsShareMessenger`true \| false	z. B. `false`
`IsShareEmail`true \| false	z. B. `true`
`IsShareLine`true \| false	z. B. `false`
`IsShareWeChat`true \| false	z. B. `false`
`IsShareInstagram`true \| false	z. B. `false`
`IsShareFlipboard`true \| false	z. B. `false`
`IsShareGeneral`true \| false	z. B. `true`

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtTeilen-Hauptschalter festlegen

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'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsShareFacebooktrue / false

IsShareTwittertrue / false

IsShareWhatsApptrue / false

IsShareTelegramtrue / false

IsShareLinkedIntrue / false

IsSharePinteresttrue / false

IsShareReddittrue / false

IsShareTumblrtrue / false

IsShareMessengertrue / false

IsShareEmailtrue / false

IsShareLinetrue / false

IsShareWeChattrue / false

IsShareInstagramtrue / false

IsShareFlipboardtrue / false

IsShareGeneraltrue / false

Bereiche — Tracking & KI

Analytics-Tracking festlegen

Fügt dem gehosteten Flipbook deine eigenen Analytics-Tracking-IDs hinzu (z. B. Google Analytics, GTM, Facebook Pixel).

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Analytics-Tracking festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`FacebookAnalyticsCode`	—
`GoogleAnalyticsCode`	—
`GoogleTagManager`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des 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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

FacebookAnalyticsCode

GoogleAnalyticsCode

GoogleTagManager

KI-Anbieter festlegen

Konfiguriert den KI-Anbieter, der für KI-Funktionen verwendet wird — den Anbieternamen und seinen API-Schlüssel.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→KI-Anbieter festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`AIProvider`	—
`AIKey`	—

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVirtuellen Assistenten festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

AIProvider

AIKey

Virtuellen Assistenten festlegen

Konfiguriert die Basiseinstellungen des virtuellen Assistenten (Chat/Hilfe) im Viewer.

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Virtuellen Assistenten festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`IsVA`true \| false	z. B. `false`
`VAButtonText`	—
`VAButtonColor`	—
`VAButtonTextColor`	—
`VAText`	Prompt / Anweisungen für den Assistenten
`VAEmbeddings`	Embeddings-Blob (String)

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtStatustext des virtuellen Assistenten festlegen KI-Anbieter festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

IsVAtrue / false

VAButtonText

VAButtonColor

VAButtonTextColor

VATextPrompt / Anweisungen für den Assistenten

VAEmbeddingsEmbeddings-Blob (String)

Statustext des virtuellen Assistenten festlegen

Legt den Status-/Begrüßungstext fest, der vom virtuellen Assistenten im Viewer angezeigt wird.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}

VoraussetzungenWer bin ich(gültiger API-Schlüssel)→Per Datei erstellen(eine flipbookId beschaffen)→Statustext des virtuellen Assistenten festlegen

Pfad-Parameter

flipbookIdnumber Numerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

`VAButtonStatus1`	Statusbeschriftung für „Hört zu“
`VAButtonStatus2`	Statusbeschriftung für „Nimmt auf“
`VAButtonStatus3`	Statusbeschriftung für „Verarbeitet“
`VAButtonStatus4`	Statusbeschriftung für „Spricht“

Fehlerantworten

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

Ein fehlender/ungültiger Schlüssel wird mit HTTP 401 abgelehnt (eine HTML-Seite, kein JSON). Jeder andere Fehler gibt HTTP 200 mit { "Result": "ERROR", "Message": … } zurück — verzweige also immer anhand von Result, nicht nur anhand des HTTP-Status.

VerwandtVirtuellen Assistenten festlegen

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>'

Beispielantwort200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Füge deinen API-Schlüssel oben unter „Dein API-Schlüssel“ ein — fülle dann die Felder unten aus und sende.

Pfad-Parameter — erforderlich, um das Item zu identifizieren

flipbookIdrequirednumberNumerische ID des Flipbooks/Dokuments — wird von create-by-file / create-by-url (als ID) oder list zurückgegeben.

Body-Parameter

VAButtonStatus1Statusbeschriftung für „Hört zu“

VAButtonStatus2Statusbeschriftung für „Nimmt auf“

VAButtonStatus3Statusbeschriftung für „Verarbeitet“

VAButtonStatus4Statusbeschriftung für „Spricht“

FlipLink API-Referenz

Einführung

Authentifizierung

Antwortformat & Result-Typen

Paginierung

Rate-Limits

Tariflimits & Kontingente

Fehler

Profil

Wer bin ich

Fehlerantworten

Profil abrufen

Fehlerantworten

Profil festlegen (teilweise)

Body-Parameter

Fehlerantworten

Abonnement & Zahlungen

Abodetails abrufen

Fehlerantworten

Zahlungen auflisten

Fehlerantworten

Items — Erstellen

Per Datei erstellen

Body (multipart/form-data)

Fehlerantworten

Per URL erstellen

Body-Parameter

Fehlerantworten

Items — Lesen

Einzelnes abrufen

Pfad-Parameter

Fehlerantworten

Per URL finden

Query-Parameter

Fehlerantworten

Auflisten

Query-Parameter

Fehlerantworten

PDF-URL abrufen

Pfad-Parameter

Fehlerantworten

Freigabe-Link abrufen

Pfad-Parameter

Fehlerantworten

Items — Ändern

Duplizieren

Pfad-Parameter

Body-Parameter

Fehlerantworten

PDF ersetzen (Datei)

Pfad-Parameter

Body (multipart/form-data)

Fehlerantworten

PDF ersetzen (URL)

Pfad-Parameter

Body-Parameter

Fehlerantworten

Als Vorlage speichern (Umschalter)

Pfad-Parameter

Body-Parameter

Fehlerantworten

Ordner zuweisen

Pfad-Parameter

Body-Parameter

Fehlerantworten

Vorder-/Rückseite festlegen (Datei)

Pfad-Parameter

Body (multipart/form-data)

Fehlerantworten

Vorder-/Rückseite festlegen (URL)

Pfad-Parameter

Body-Parameter

Fehlerantworten

Vorder-/Rückseite entfernen

Pfad-Parameter

Fehlerantworten

Ablauf festlegen / Ablauf entfernen

Pfad-Parameter

Body-Parameter

Fehlerantworten