Connect Links

Create a white-label link for connecting social accounts

Send no body for a quick link: it lasts 7 days, offers every platform, shows the client every account in the workspace and connects any number of accounts. A link with maxAccounts stops working once that many accounts are connected through it. Requires the accounts.manage permission.

post/connect-links

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/connect-links
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Request body

namestring

Label shown in the dashboard list of links

visibility'PUBLIC' | 'PRIVATE'

PRIVATE shows the client only the accounts they connected through this link. Defaults to PUBLIC

allowedPlatformsstring[]

Platforms the client can pick. Omit or send [] for every platform

maxAccountsinteger

Accounts the link can connect in total. Reconnecting an account it already connected does not count again

Response

Connect link

urlstring
tokenstring
expiresAtstring
namestring nullable
visibility'PUBLIC' | 'PRIVATE'
allowedPlatformsstring[]
maxAccountsinteger nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.