REST APIPOST

Verbindungslinks

Erstellen Sie einen Link, mit dem ein Kunde seine Social-Media-Konten ohne AdaptlyPost-Anmeldung mit Ihrem Workspace verbindet, und widerrufen Sie ihn, wenn Sie fertig sind.

Berechtigung: accounts.manage. Siehe Rollen und Berechtigungen.

Nur ein Admin-Schlüssel hat accounts.manage, daher können nur Admin-Schlüssel Verbindungslinks erstellen oder widerrufen.

Ein Verbindungslink öffnet eine Seite, auf der jemand ohne AdaptlyPost-Konto seine Social-Media-Konten mit Ihrem Workspace verbindet. Senden Sie die url an einen Kunden, er bestätigt jede Plattform, und die Konten erscheinen wie alle anderen unter Social Accounts.

POST /api/v1/connect-links

Alle Felder sind optional. Ohne Body entsteht ein Schnell-Link: Er bietet jede Plattform an, zeigt dem Kunden alle Konten im Workspace, verbindet beliebig viele Konten und läuft nach 7 Tagen ab.

FeldTypBeschreibung
nameString, bis zu 80 ZeichenBezeichnung in der Liste der Links im Dashboard. Nur Ihr Team sieht sie
visibilityPUBLIC oder PRIVATEPRIVATE zeigt dem Kunden nur die Konten, die er über diesen Link verbunden hat. Standard ist PUBLIC
allowedPlatformsArray von PlattformtypenPlattformen, die der Kunde wählen kann. Weglassen oder [] senden für alle Plattformen
maxAccountsGanzzahl ab 1Der Link funktioniert nicht mehr, sobald so viele Konten darüber verbunden sind. Ein erneut verbundenes Konto, das der Link schon verbunden hat, zählt nicht doppelt
expiresAtISO-8601-Datum mit Uhrzeit und Z oder OffsetWann der Link abläuft. Mindestens 1 Stunde und höchstens 365 Tage in der Zukunft. Standard ist in 7 Tagen
neverExpiresBooleantrue lässt den Link gelten, bis er widerrufen wird. Nicht zusammen mit expiresAt senden

Beispiel-Request:

{
  "name": "Acme onboarding",
  "visibility": "PRIVATE",
  "allowedPlatforms": ["INSTAGRAM", "TIKTOK"],
  "maxAccounts": 3,
  "expiresAt": "2026-11-30T18:00:00Z"
}

Antwortet mit 201:

{
  "url": "https://adaptlypost.com/connect/9f2c4e71b0d8...",
  "token": "9f2c4e71b0d8...",
  "expiresAt": "2026-11-30T18:00:00.000Z",
  "name": "Acme onboarding",
  "visibility": "PRIVATE",
  "allowedPlatforms": ["INSTAGRAM", "TIKTOK"],
  "maxAccounts": 3
}
FeldBeschreibung
urlDie Seite zum Versenden. Wer sie hat, kann Konten mit diesem Workspace verbinden, solange der Link gilt
tokenKennzeichnet den Link. Bewahren Sie ihn auf, um den Link später zu widerrufen
expiresAtWann der Link abläuft, oder null für einen Link, der nie abläuft
name, visibility, allowedPlatforms, maxAccountsDie Einstellungen, mit denen der Link erstellt wurde. name und maxAccounts sind null, wenn sie nicht gesetzt sind

Ein expiresAt außerhalb des Bereichs oder expiresAt zusammen mit neverExpires ergibt 400 mit einer Meldung, die den Grund nennt.

Ein Link funktioniert außerdem nicht mehr, sobald er widerrufen wird, sobald er maxAccounts Konten verbunden hat oder das Mitglied, das ihn erstellt hat, im Workspace keine Konten mehr verwalten darf.

DELETE /api/v1/connect-links/:token

Widerruft den Link sofort. Bereits darüber verbundene Konten bleiben verbunden. Antwortet mit { "success": true } oder mit 404, wenn kein Link in diesem Workspace dieses Token hat.