Connect Links
Create a link that lets a client connect their social accounts to your workspace without an AdaptlyPost login, and revoke it when you are done.
Permission: accounts.manage. See Roles and permissions.
Only an Admin key holds accounts.manage, so only Admin keys can create or revoke connect links.
A connect link opens a page where someone without an AdaptlyPost account connects their social accounts to your workspace. Send the url to a client, they approve each platform, and the accounts appear in Social Accounts like any other.
POST /api/v1/connect-links
Every field is optional. Send no body for a quick link: it offers every platform, shows the client every account in the workspace, connects any number of accounts and stops working after 7 days.
| Field | Type | Description |
|---|---|---|
name | string, up to 80 characters | Label in the dashboard list of links. Only your team sees it |
visibility | PUBLIC or PRIVATE | PRIVATE shows the client only the accounts they connected through this link. Defaults to PUBLIC |
allowedPlatforms | array of platform types | Platforms the client can pick. Leave it out or send [] for every platform |
maxAccounts | integer, 1 or more | The link stops working once this many accounts are connected through it. Reconnecting an account it already connected does not count again |
expiresAt | ISO 8601 date-time with Z or an offset | When the link stops working. At least 1 hour and at most 365 days away. Defaults to 7 days from now |
neverExpires | boolean | true keeps the link working until it is revoked. Don't send it together with expiresAt |
Example request:
{
"name": "Acme onboarding",
"visibility": "PRIVATE",
"allowedPlatforms": ["INSTAGRAM", "TIKTOK"],
"maxAccounts": 3,
"expiresAt": "2026-11-30T18:00:00Z"
}Returns 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
}| Field | Description |
|---|---|
url | The page to send. Anyone who has it can connect accounts to this workspace while the link works |
token | Identifies the link. Keep it to revoke the link later |
expiresAt | When the link stops working, or null for a link that never expires |
name, visibility, allowedPlatforms, maxAccounts | The settings the link was made with. name and maxAccounts are null when not set |
An expiresAt outside the range, or expiresAt together with neverExpires, returns 400 with a message saying which.
A link also stops working as soon as it is revoked, once it has connected maxAccounts accounts, or when the member who created it can no longer manage accounts in the workspace.
DELETE /api/v1/connect-links/:token
Revokes the link at once. Accounts already connected through it stay connected. Returns { "success": true }, or 404 when no link in this workspace has that token.